com.sun.identity.federation.services.registration

Class FSNameRegistrationHandler

java.lang.Object

com.sun.identity.federation.services.registration.FSNameRegistrationHandler

public class FSNameRegistrationHandler
extends Object

Work class that handles registration process.

Field Summary

Fields

Modifier and Type	Field and Description
protected FSAccountFedInfo	acctInfo
protected com.sun.identity.federation.jaxb.entityconfig.BaseConfigType	hostedConfig
protected com.sun.identity.liberty.ws.meta.jaxb.ProviderDescriptorType	hostedDescriptor
protected String	hostedEntityId
protected String	hostedProviderRole
protected FSAccountManager	managerInst
protected String	metaAlias
protected FSAccountFedInfo	newAcctInfo
protected FSAccountFedInfoKey	newAcctKey
protected FSAccountFedInfoKey	oldAcctKey
protected String	realm
protected HashMap	regisMap
protected FSNameRegistrationRequest	regisRequest
protected FSNameRegistrationResponse	regisResponse
protected static String	regisSource
protected static String	REGISTRATION_DONE_URL
protected static String	RELAY_STATE
protected String	relayState
protected com.sun.identity.liberty.ws.meta.jaxb.ProviderDescriptorType	remoteDescriptor
protected String	remoteEntityId
protected javax.servlet.http.HttpServletRequest	request
protected javax.servlet.http.HttpServletResponse	response
protected HashMap	returnMap
protected static String	returnURL
protected Object	ssoToken
protected String	userID

Constructor Summary

Constructors

Constructor and Description
FSNameRegistrationHandler() Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	handleNameRegistration(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Object ssoToken) Initiates the name registration operation.
boolean	handleNameRegistration(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Object ssoToken, HashMap valMap) Handles the name registration after sso.
boolean	handleRegistrationAfterFederation(String LRURL, javax.servlet.http.HttpServletResponse response) Does local name registration and initiates remote registration with the IDP.
void	processRegistrationRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, FSNameRegistrationRequest regisRequest) Processes the registration request received from a remote provider.
boolean	processRegistrationResponse(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, FSNameRegistrationResponse regisResponse) Initiates the name registration operation.
FSNameRegistrationResponse	processSOAPRegistrationRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, FSNameRegistrationRequest regisRequest) Processes the name registration request received from a remote provider.
void	returnLocallyAtSource(javax.servlet.http.HttpServletResponse response, boolean isSuccess) Redirects to final destination after registration.
void	setAccountInfo(FSAccountFedInfo acctInfo) Sets the federation account information for the user with a specific remote provider.
void	setHostedDescriptor(com.sun.identity.liberty.ws.meta.jaxb.ProviderDescriptorType hostedDescriptor) Sets hosted provider descriptor.
void	setHostedDescriptorConfig(com.sun.identity.federation.jaxb.entityconfig.BaseConfigType hostedConfig) Sets hosted provider's extended meta.
void	setHostedEntityId(String hostedId) Sets hosted provider's entity ID.
void	setHostedProviderRole(String hostedRole) Sets hosted provider's role.
void	setMetaAlias(String metaAlias) Sets hosted provider's meta alias.
void	setRealm(String realm) Sets realm.
protected void	setRegistrationURL() Invoked to set some commonly used URLs based on hosted provider.
void	setRemoteDescriptor(com.sun.identity.liberty.ws.meta.jaxb.ProviderDescriptorType remoteDescriptor) Sets remote provider descriptor.
void	setRemoteEntityId(String remoteId) Sets remote provider's entity ID.
boolean	setUserDN(FSNameRegistrationRequest regisRequest) Determines the user based on the registration request received from a remote provider.
void	setUserID(String userID) Sets the UserDN.
protected SOAPMessage	signRegistrationRequest(SOAPMessage msg, String idAttrName, String id) Signs the Name registration request before sending it to the IDP.
protected boolean	verifyResponseSignature(SOAPMessage msg, boolean isIDP) Verifies the Name registration response received from the IDP before processing locally.

Methods inherited from class java.lang.Object

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

Field Detail

response

protected javax.servlet.http.HttpServletResponse response

request

protected javax.servlet.http.HttpServletRequest request

regisMap

protected HashMap regisMap

regisResponse

protected FSNameRegistrationResponse regisResponse

regisRequest

protected FSNameRegistrationRequest regisRequest

ssoToken

protected Object ssoToken

userID

protected String userID

acctInfo

protected FSAccountFedInfo acctInfo

newAcctInfo

protected FSAccountFedInfo newAcctInfo

newAcctKey

protected FSAccountFedInfoKey newAcctKey

oldAcctKey

protected FSAccountFedInfoKey oldAcctKey

remoteDescriptor

protected com.sun.identity.liberty.ws.meta.jaxb.ProviderDescriptorType remoteDescriptor

hostedDescriptor

protected com.sun.identity.liberty.ws.meta.jaxb.ProviderDescriptorType hostedDescriptor

hostedConfig

protected com.sun.identity.federation.jaxb.entityconfig.BaseConfigType hostedConfig

metaAlias

protected String metaAlias

relayState

protected String relayState

managerInst

protected FSAccountManager managerInst

REGISTRATION_DONE_URL

protected static String REGISTRATION_DONE_URL

RELAY_STATE

protected static final String RELAY_STATE

See Also:

Constant Field Values

returnMap

protected HashMap returnMap

returnURL

protected static String returnURL

regisSource

protected static String regisSource

remoteEntityId

protected String remoteEntityId

realm

protected String realm

hostedEntityId

protected String hostedEntityId

hostedProviderRole

protected String hostedProviderRole

Constructor Detail

FSNameRegistrationHandler

public FSNameRegistrationHandler()

Constructor. Initializes FSAccountManager, meta Manager instance.

Method Detail

setRegistrationURL

protected void setRegistrationURL()

Invoked to set some commonly used URLs based on hosted provider.

setHostedDescriptor

public void setHostedDescriptor(com.sun.identity.liberty.ws.meta.jaxb.ProviderDescriptorType hostedDescriptor)

Sets hosted provider descriptor. This function is called from FSServiceManager to give state to the name registration handler that is handling the current name registration. The hosted provider identifies the provider who is handling the registration request or initiating it locally.

Parameters:

hostedDescriptor - the Hosted provider Descriptor

setHostedDescriptorConfig

public void setHostedDescriptorConfig(com.sun.identity.federation.jaxb.entityconfig.BaseConfigType hostedConfig)

Sets hosted provider's extended meta.

Parameters:

hostedConfig - hosted provider's extended meta.

setHostedEntityId

public void setHostedEntityId(String hostedId)

Sets hosted provider's entity ID.

Parameters:

hostedId - hosted provider's entity ID

setHostedProviderRole

public void setHostedProviderRole(String hostedRole)

Sets hosted provider's role.

Parameters:

hostedRole - hosted provider's role

setMetaAlias

public void setMetaAlias(String metaAlias)

Sets hosted provider's meta alias.

Parameters:

metaAlias - hosted provider's meta alias

setRealm

public void setRealm(String realm)

Sets realm.

Parameters:

realm - The realm under which the entity resides.

setRemoteEntityId

public void setRemoteEntityId(String remoteId)

Sets remote provider's entity ID.

Parameters:

remoteId - remote provider's entity ID

setRemoteDescriptor

public void setRemoteDescriptor(com.sun.identity.liberty.ws.meta.jaxb.ProviderDescriptorType remoteDescriptor)

Sets remote provider descriptor. This function is called to give state to the Name registration handler The remote provider identifies the provider who sent a request or with whom registration is to be initiated.

Parameters:

remoteDescriptor - the Remote provider Descriptor

setUserID

public void setUserID(String userID)

Sets the UserDN.

Parameters:

userID - the user who is initiating

setAccountInfo

public void setAccountInfo(FSAccountFedInfo acctInfo)

Sets the federation account information for the user with a specific remote provider.

Parameters:

acctInfo - the account fed info object

setUserDN

public boolean setUserDN(FSNameRegistrationRequest regisRequest)

Determines the user based on the registration request received from a remote provider.

Parameters:

regisRequest - the name registration request

Returns:

true a user is found; false otherwise.

handleNameRegistration

public boolean handleNameRegistration(javax.servlet.http.HttpServletRequest request,
                                      javax.servlet.http.HttpServletResponse response,
                                      Object ssoToken)

Initiates the name registration operation.

Parameters:

request - HTTP request

response - HTTP response

ssoToken - corresponding to the user's session

Returns:

the status of the registration initiation operation. true if successful; false otherwise.

handleNameRegistration

public boolean handleNameRegistration(javax.servlet.http.HttpServletRequest request,
                                      javax.servlet.http.HttpServletResponse response,
                                      Object ssoToken,
                                      HashMap valMap)

Handles the name registration after sso.

Parameters:

request - HTTP request

response - HTTP response

ssoToken - corresponding to the users's session

Returns:

the status of the registration initiation operation. true if successful; false otherwise.

handleRegistrationAfterFederation

public boolean handleRegistrationAfterFederation(String LRURL,
                                                 javax.servlet.http.HttpServletResponse response)

Does local name registration and initiates remote registration with the IDP.

Parameters:

LRURL - the final return URL after Name registration is complete

response - HTTP response object

Returns:

true if successful; false otherwise.

processRegistrationResponse

public boolean processRegistrationResponse(javax.servlet.http.HttpServletRequest request,
                                           javax.servlet.http.HttpServletResponse response,
                                           FSNameRegistrationResponse regisResponse)

Initiates the name registration operation.

Parameters:

request - HTTP request

response - HTTP response

regisResponse - FSNameRegistrationResponse object

Returns:

true if the operation succeeds; false otherwise.

processRegistrationRequest

public void processRegistrationRequest(javax.servlet.http.HttpServletRequest request,
                                       javax.servlet.http.HttpServletResponse response,
                                       FSNameRegistrationRequest regisRequest)

Processes the registration request received from a remote provider. Invoded when Http redirect profile is used.

Parameters:

request - HTTP request

response - HTTP response

regisRequest - the name registration request received from remote provider

processSOAPRegistrationRequest

public FSNameRegistrationResponse processSOAPRegistrationRequest(javax.servlet.http.HttpServletRequest request,
                                                                 javax.servlet.http.HttpServletResponse response,
                                                                 FSNameRegistrationRequest regisRequest)

Processes the name registration request received from a remote provider. Invoded when SOAP profile is used.

Parameters:

regisRequest - the name registration request received from remote provider

returnLocallyAtSource

public void returnLocallyAtSource(javax.servlet.http.HttpServletResponse response,
                                  boolean isSuccess)

Redirects to final destination after registration. Invoked at the end of the registration operation at the end where registration was initiated. The isSuccess determines if a success message or a failure message is displayed.

Parameters:

response - HttpServletResponse object

isSuccess - determines the content of the registration-done.jsp

signRegistrationRequest

protected SOAPMessage signRegistrationRequest(SOAPMessage msg,
                                              String idAttrName,
                                              String id)
                                       throws SAMLException,
                                              FSMsgException

Signs the Name registration request before sending it to the IDP.

Parameters:

msg - the request message to be sent to IDP

idAttrName - name of the id attribute to be signed

id - the value of the id attribute to be signed

Returns:

signed Name registration request

Throws:

SAMLException, - FSMsgException if error occurred.

SAMLException

FSMsgException

verifyResponseSignature

protected boolean verifyResponseSignature(SOAPMessage msg,
                                          boolean isIDP)

Verifies the Name registration response received from the IDP before processing locally.

Parameters:

msg - the response message

isIDP - whether the remote provider is an IDP or not

Returns:

true if signature is valid; false otherwise.