org.assistments.service.manager.core.impl

Class PartnerManagerImpl

java.lang.Object

org.assistments.service.manager.content.impl.ManagerHelperImpl<Partner>

org.assistments.service.manager.core.impl.PartnerManagerImpl

All Implemented Interfaces:

ManagerHelper<Partner>, PartnerManager

@Component
public class PartnerManagerImpl
extends ManagerHelperImpl<Partner>
implements PartnerManager

Nested Class Summary

Nested classes/interfaces inherited from interface org.assistments.service.manager.core.PartnerManager

PartnerManager.UpdateField

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	classType

Constructor Summary

Constructors

Constructor and Description
PartnerManagerImpl()

Method Summary

Modifier and Type	Method and Description
boolean	exists(java.lang.String partnerRef) Returns whether a partner reference exists (as a registered ASSISTments partner).
Partner	getMyPartner() Returns the current application's or service's Partner object originating from the PartnerCredentials as defined in the current application's configuration file (xml).
int	getMyPartnerId() Returns the current application's or service's Partner ID originating from persisted version of PartnerCredentials as defined in the current application's configuration file (xml).
java.lang.String	getMyPartnerRef() Returns the current application's or service's Partner external reference name originating from the PartnerCredentials as defined in the current application's configuration file (xml).
Partner	getPartner(java.lang.String partnerRef) Returns the Partner object for the named partner
int	getPartnerId(java.lang.String partnerRef) Returns the database ID for a partner reference Note: For use only by Service Administrators.
java.util.List<java.lang.String>	getPartnerReferences() Returns a list of all partner references
java.util.List<Partner>	getPartners()
Partner	getRequestingPartner() Returns the Partner object for the requesting application or service.
int	getRequestingPartnerId() Returns the persisted Partner ID for the requesting application or service.
java.lang.String	getRequestingPartnerRef() Returns the Partner reference for the requesting application or service.
void	init()
java.util.List<Partner>	registerDependencies(PartnerCredentials pCreds)
Partner	registerOrUpdate(PartnerCredentials partnerCreds) Registers a new application with the ASSISTmetns Service (AS)
void	update(java.util.List<Pair<PartnerManager.UpdateField,java.lang.String>> values)
void	update(java.lang.String partnerRef, java.util.List<Pair<PartnerManager.UpdateField,java.lang.String>> values) Updates a partner application's select registration fields
void	updateRegistration(Partner partner) Updates a partner application's registration.

Methods inherited from class org.assistments.service.manager.content.impl.ManagerHelperImpl

createExternalReferenceFor

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

classType

public static final java.lang.String classType

Constructor Detail

PartnerManagerImpl

public PartnerManagerImpl()

Method Detail

init

@PostConstruct
public void init()

registerOrUpdate

@Transactional
public Partner registerOrUpdate(PartnerCredentials partnerCreds)
                                         throws AlreadyExistsException

Description copied from interface: PartnerManager

Registers a new application with the ASSISTmetns Service (AS)

Only the AS admin applications is allowed to call this method.

Specified by:

registerOrUpdate in interface PartnerManager

Parameters:

partnerCreds - Partner application to register

Returns:

The resulting Partner object

Throws:

AlreadyExistsException - If partnerRef is already in use

registerDependencies

public java.util.List<Partner> registerDependencies(PartnerCredentials pCreds)

Specified by:

registerDependencies in interface PartnerManager

updateRegistration

public void updateRegistration(Partner partner)

Description copied from interface: PartnerManager

Updates a partner application's registration.

Note: Presently for use only by System Administrators. Going forward, the API should allow partner applications to update a subset of their registration data.

Replaces all partner application fields with the values provided. The correct use of this method is to call PartnerManager.getPartner(String), update the returned PartnerApplication object and to pass the updated object to this method.

Specified by:

updateRegistration in interface PartnerManager

Parameters:

partner - New settings

See Also:

PartnerManager.getPartner(String)

exists

public boolean exists(java.lang.String partnerRef)

Description copied from interface: PartnerManager

Returns whether a partner reference exists (as a registered ASSISTments partner).

Note: For use only by Service Administrators.

Specified by:

exists in interface PartnerManager

Parameters:

partnerRef - Partner reference of interest

Returns:

true if partnerRef is a registered partner; otherwise false

getMyPartner

public Partner getMyPartner()
                     throws NotFoundException

Description copied from interface: PartnerManager

Returns the current application's or service's Partner object originating from the PartnerCredentials as defined in the current application's configuration file (xml).

Note: Use with caution. In most cases you are interested in the requesting partner as your application is acting on behalf of that requestor. See PartnerManager.getRequestingPartner().

Specified by:

getMyPartner in interface PartnerManager

Returns:

Partner object

Throws:

NotFoundException - If somehow the current application does not have a persisted entry. Unexpected.

getMyPartnerRef

public java.lang.String getMyPartnerRef()

Description copied from interface: PartnerManager

Returns the current application's or service's Partner external reference name originating from the PartnerCredentials as defined in the current application's configuration file (xml).

Note: Use with caution. In most cases you are interested in the requesting partner as your application is acting on behalf of that requestor. See PartnerManager.getRequestingPartnerRef().

Specified by:

getMyPartnerRef in interface PartnerManager

Returns:

The partner ref

getMyPartnerId

public int getMyPartnerId()
                   throws NotFoundException

Description copied from interface: PartnerManager

Returns the current application's or service's Partner ID originating from persisted version of PartnerCredentials as defined in the current application's configuration file (xml).

Note: Use with caution. In most cases you are interested in the requesting partner as your application is acting on behalf of that requestor. See PartnerManager.getRequestingPartnerId().

Specified by:

getMyPartnerId in interface PartnerManager

Returns:

Partner object

Throws:

NotFoundException - If somehow the current application does not have a persisted entry. Unexpected.

getRequestingPartner

public Partner getRequestingPartner()

Description copied from interface: PartnerManager

Returns the Partner object for the requesting application or service.

Specified by:

getRequestingPartner in interface PartnerManager

Returns:

Requestor's Partner object

getRequestingPartnerRef

public java.lang.String getRequestingPartnerRef()

Description copied from interface: PartnerManager

Returns the Partner reference for the requesting application or service.

Specified by:

getRequestingPartnerRef in interface PartnerManager

Returns:

Requestor's Partner reference

getRequestingPartnerId

public int getRequestingPartnerId()
                           throws NotFoundException

Description copied from interface: PartnerManager

Returns the persisted Partner ID for the requesting application or service.

Specified by:

getRequestingPartnerId in interface PartnerManager

Returns:

Requestor's Partner ID.

Throws:

NotFoundException - If the requestor presented an invalid partner reference.

getPartner

public Partner getPartner(java.lang.String partnerRef)
                   throws NotFoundException

Description copied from interface: PartnerManager

Returns the Partner object for the named partner

Note: For use only by Service Administrators. For their application, partners call #getPartner().

Specified by:

getPartner in interface PartnerManager

Parameters:

partnerRef - Partner reference

Returns:

The Partner object for partnerRef

Throws:

NotFoundException - If the named application is not a registered partner.

getPartnerId

public int getPartnerId(java.lang.String partnerRef)
                 throws NotFoundException

Description copied from interface: PartnerManager

Returns the database ID for a partner reference Note: For use only by Service Administrators. For their application, partners call #getPartnerId().

Specified by:

getPartnerId in interface PartnerManager

Parameters:

partnerRef - Partner reference of interest

Returns:

The database ID of partnerRef

Throws:

NotFoundException - If the specified partnerRef is not found

getPartners

public java.util.List<Partner> getPartners()

Specified by:

getPartners in interface PartnerManager

getPartnerReferences

public java.util.List<java.lang.String> getPartnerReferences()

Description copied from interface: PartnerManager

Returns a list of all partner references

Specified by:

getPartnerReferences in interface PartnerManager

Returns:

The list of registered partner references Note: For use only by Service Administrators.

update

public void update(java.util.List<Pair<PartnerManager.UpdateField,java.lang.String>> values)

Specified by:

update in interface PartnerManager

update

public void update(java.lang.String partnerRef,
                   java.util.List<Pair<PartnerManager.UpdateField,java.lang.String>> values)

Description copied from interface: PartnerManager

Updates a partner application's select registration fields

Specified by:

update in interface PartnerManager

Parameters:

partnerRef - Partner application reference to update

values - List of fields and values to update