Package de.aristaflow.adept2.base.security.callbackhandler

Class UniversalHandler

java.lang.Object

de.aristaflow.adept2.base.security.callbackhandler.UniversalHandler

All Implemented Interfaces:

AFCallbackHandler

public class UniversalHandler
extends Object
implements AFCallbackHandler

This handler provides the means to handle all used callbacks, i. e. NameCallback, PasswordCallback, OrgPositionChoiceCallback, AppNameCallback, and UserSessionIDCallback. All data is provided in the constructor of this handler. Which of these callbacks are handled depends on the provided data, e. g. when not providing a password. the PasswordCallback will not be handled.

Constructor Summary

Constructors

Modifier	Constructor	Description
	UniversalHandler(String userName, String password, long orgPosId, String appName, String userSessionId)	Creates a new handler for NameCallback, PasswordCallback, OrgPositionChoiceCallback, AppNameCallback and UserSessionIDCallback.
protected	UniversalHandler(String userName, String password, Long orgPosId, List<QualifiedAgent> orgPosIds, String appName, String userSessionId)	Creates a new handler for Callbacks appropriate for the designated parameters.
	UniversalHandler(String userName, String password, String appName, String userSessionId)	Creates a new handler for NameCallback, PasswordCallback, AppNameCallback and UserSessionIDCallback.
	UniversalHandler(String password, List<QualifiedAgent> orgPosIds, String appName, String userSessionId)	Creates a new handler for PasswordCallback, OrgPositionChoiceCallback, AppNameCallback and UserSessionIDCallback.

Method Summary

Modifier and Type	Method	Description
Callback[]	handle(Callback[] callbacks)	This method is similar to CallbackHandler.handle(Callback[]) but returns the provided callbacks back to the caller.

Methods inherited from class java.lang.Object

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

Constructor Detail

UniversalHandler

public UniversalHandler(String userName,
                        String password,
                        String appName,
                        String userSessionId)

Creates a new handler for NameCallback, PasswordCallback, AppNameCallback and UserSessionIDCallback.

Parameters:

userName - The unique name of the user to log on. This must not be null nor an empty/blank string. Note that this name is case-sensitive!

password - The password of the user to log on or null.

appName - The application name for which to log on or null.

userSessionId - The user session ID which to use for all provided agents or null.

UniversalHandler

public UniversalHandler(String userName,
                        String password,
                        long orgPosId,
                        String appName,
                        String userSessionId)

Creates a new handler for NameCallback, PasswordCallback, OrgPositionChoiceCallback, AppNameCallback and UserSessionIDCallback.

Parameters:

userName - The unique name of the user to log on. This must not be null nor an empty/blank string. Note that this name is case-sensitive!

password - The password of the user to log on or null.

orgPosId - The ID of the org position of the agent who to log on or null.

appName - The application name for which to log on or null.

userSessionId - The user session ID which to use for the designated org position..

UniversalHandler

public UniversalHandler(String password,
                        List<QualifiedAgent> orgPosIds,
                        String appName,
                        String userSessionId)

Creates a new handler for PasswordCallback, OrgPositionChoiceCallback, AppNameCallback and UserSessionIDCallback.

Parameters:

password - The password of the user to log on or null.

orgPosIds - The IDs of the org positions of the agent who to log on or null.

appName - The application name for which to log on or null.

userSessionId - The user session ID which to use for the designated agents or null.

UniversalHandler

protected UniversalHandler(String userName,
                           String password,
                           Long orgPosId,
                           List<QualifiedAgent> orgPosIds,
                           String appName,
                           String userSessionId)

Creates a new handler for Callbacks appropriate for the designated parameters.

Parameters:

userName - The unique name of the user to log on. This must not be null nor an empty/blank string except when a list of agents is provided.

password - The password of the user to log on or null.

orgPosId - The org position ID of the agent who to log on or null.

orgPosIds - The IDs of the org positions of the agent who to log on or null. If this is set, userName and orgPosId both have to be null.

appName - The application name for which to log on or null.

userSessionId - The user session ID which to use for all provided agents or null.

Method Detail

handle

public Callback[] handle(Callback[] callbacks)
                  throws IOException,
                         UnsupportedCallbackException

Description copied from interface: AFCallbackHandler

This method is similar to CallbackHandler.handle(Callback[]) but returns the provided callbacks back to the caller. This allows for calling this method remotely. Note that all callbacks need to be serialisable.
When called remotely, the provided callbacks are copies of the server-side objects. When changing these objects, the changes are not reflected on server side. Therefore these objects (or rather copies of them) need to be returned.

Specified by:

handle in interface AFCallbackHandler

Parameters:

callbacks - The callbacks to be handled by this callback handler.

Returns:

All the callbacks that should be handled by this callback handler. Just return the complete array of callbacks. Do not skip any callbacks, for instance the ones that the callback handler did not handle!

Throws:

IOException - If an input or output error occurs, an IOException will be thrown.

UnsupportedCallbackException - If the implementation of this method does not support one or more of the callbacks specified in the callbacks parameter, an UnsupportedCallbackException will be thrown.