com.manageengine.pam360.sdk.services

Class ClientRegistrationManager

java.lang.Object

com.manageengine.pam360.sdk.services.ClientRegistrationManager

public class ClientRegistrationManager
extends java.lang.Object

Used to register, update and manage the SDK Client and the local configuration.

Constructor Summary

Constructors

Constructor and Description
ClientRegistrationManager(ServiceConfiguration configurations) Default constructor

Method Summary

Modifier and Type	Method and Description
boolean	isRegistered() Check whether the client configuration is available
void	register(java.lang.String registrationToken) Register a client with the given token.
void	register(java.lang.String registrationToken, java.lang.String clientName) Register a client with the given token and the client name.
void	removeConfiguration() Remove the locally stored client configurations.
void	update(java.lang.String registrationToken) Update the client with the given configuration, if the updating existing client fails, PAM360 server will try to register a new client.
void	update(java.lang.String registrationToken, java.lang.String clientName) Update the client with the given configuration, if the updating existing client fails, PAM360 server will try to register a new client.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientRegistrationManager

public ClientRegistrationManager(ServiceConfiguration configurations)
                          throws SDKOperationFailedException,
                                 SDKInvalidArgumentException

Default constructor

Parameters:

configurations - instance of ServiceConfiguration

Throws:

SDKOperationFailedException - This exception along with the reason is thrown if PAMService instantiation fails

SDKInvalidArgumentException - This exception is thrown if configurations have invalid or null data

Method Detail

isRegistered

public boolean isRegistered()

Check whether the client configuration is available

Returns:

true if the client is registered (configurations are available)

register

public void register(java.lang.String registrationToken)
              throws SDKConnectionException,
                     SDKRegistrationException,
                     SDKInvalidArgumentException

Register a client with the given token. If the client is already registered, the registration call is skipped

Parameters:

registrationToken, - The appropriate registration token

Throws:

SDKConnectionException - This exception is thrown if the SDK is unable to contact PAM360 server for registration

SDKInvalidArgumentException - This exception is thrown if registrationToken argument is null

SDKRegistrationException - This exception along with the reason is thrown if the registration fails

register

public void register(java.lang.String registrationToken,
                     java.lang.String clientName)
              throws SDKConnectionException,
                     SDKRegistrationException,
                     SDKInvalidArgumentException

Register a client with the given token and the client name. If the client is already registered, the registration call is skipped

Parameters:

registrationToken, - The appropriate registration token

clientName - mandatory not null,name of the client registering

Throws:

SDKConnectionException - This exception is thrown if the SDK is unable to contact PAM360 server for registration

SDKInvalidArgumentException - This exception is thrown if registrationToken, clientName arguments are null or empty

SDKRegistrationException - This exception along with the reason is thrown if the registration fails

update

public void update(java.lang.String registrationToken)
            throws SDKInvalidArgumentException,
                   SDKConnectionException,
                   SDKRegistrationException

Update the client with the given configuration, if the updating existing client fails, PAM360 server will try to register a new client.

Parameters:

registrationToken, - The appropriate registration token

Throws:

SDKConnectionException - This exception is thrown if the SDK is unable to contact PAM360 server for registration

SDKInvalidArgumentException - This exception is thrown if configuration argument is null

SDKRegistrationException - This exception along with the reason is thrown if the registration fails

update

public void update(java.lang.String registrationToken,
                   java.lang.String clientName)
            throws SDKInvalidArgumentException,
                   SDKConnectionException,
                   SDKRegistrationException

Update the client with the given configuration, if the updating existing client fails, PAM360 server will try to register a new client.

Parameters:

registrationToken, - The appropriate registration token

Throws:

SDKConnectionException - This exception is thrown if the SDK is unable to contact PAM360 server for registration

SDKInvalidArgumentException - This exception is thrown if configuration argument is null

SDKRegistrationException - This exception along with the reason is thrown if the registration fails

removeConfiguration

public void removeConfiguration()
                         throws SDKRegistrationException

Remove the locally stored client configurations.

Throws:

SDKRegistrationException - This exception is thrown if the client is not registered