|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.filenet.wcm.toolkit.server.util.WcmSignInProcessor
An instance of this object will deliver credentials to the target session specified in the constructor, using the credentials servlet if necessary, provided that the target session information is current and valid.
Field Summary | |
protected WcmController |
controller
|
protected boolean |
disableInternalToken
|
protected java.lang.String |
encodedSessionId
|
protected java.lang.String |
errorMessage
|
protected java.lang.Exception |
lastException
|
protected java.lang.Boolean |
localSession
localSession is no longer used. |
protected int |
maxErrorLength
|
protected boolean |
noSession
|
protected java.lang.String |
originIP
|
protected java.lang.String |
originPort
|
protected java.lang.String |
originScheme
|
protected java.lang.String |
originSessionId
|
protected WcmException |
sessionInvalidException
|
protected java.lang.String |
targetBase
|
protected java.lang.String |
targetUrl
|
protected java.lang.String |
userId
|
Constructor Summary | |
WcmSignInProcessor(WcmController c,
java.lang.String originIPValue,
java.lang.String originPortValue,
java.lang.String originSessionIdValue,
java.lang.String originSchemeValue,
java.lang.String encodedSessionIdValue)
|
|
WcmSignInProcessor(WcmController c,
java.lang.String originIPValue,
java.lang.String originPortValue,
java.lang.String originSessionIdValue,
java.lang.String targetBaseValue,
java.lang.String targetUrlValue,
java.lang.String encodedSessionIdValue)
|
Method Summary | |
void |
clearStatus()
Clears out the last userId and errorMessage values. |
protected void |
configure(WcmController c,
java.lang.String originIP,
java.lang.String originPort,
java.lang.String originSessionId,
java.lang.String originScheme,
java.lang.String encodedSessionId)
Configure the sign in processor with the information required to set credentials in the target session. |
boolean |
doSignInWork(java.lang.String userId,
java.lang.String password,
WcmRequestMap extraParameters,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Sets the credentials in the target session whether it is remote or local. |
java.lang.String |
getErrorMessage()
Get the current sign in error message, if it exists. |
java.lang.Exception |
getException()
Get the last sign in exception, if it exists. |
java.lang.String |
getLocalSessionId(javax.servlet.http.HttpServletRequest request)
Gets the current local session ID for the specified request. |
int |
getMaxErrorLength()
Gets the maxErrorLength property value. |
boolean |
getNoSession()
Return true if the last sign in attempt could not find the target session. |
java.lang.String |
getTargetBase()
Get the target base URL path. |
java.lang.String |
getTargetUrl()
Get the target URL page. |
java.lang.String |
getUserID()
Get the current sign in user ID. |
boolean |
isServerLocal()
Discern whether or not the current local session is also the target session. |
boolean |
isSessionLocal(javax.servlet.http.HttpServletRequest request)
Discern whether or not the current local session is also the target session. |
void |
setDisableInternalToken(boolean value)
Disable sign-in attempt via internal user token even if internal tokens are configured enabled. |
int |
setMaxErrorLength(int newValue)
Set the max error length to a value other than the initial default. |
java.lang.String |
signIn(javax.servlet.http.HttpServletRequest request,
java.lang.String userId,
java.lang.String password,
WcmRequestMap extraParameters)
Sets the credentials in the target session whether it is remote or local. |
java.lang.String |
signInLocal(java.lang.String user,
java.lang.String password,
WcmRequestMap extraParameters)
Sets the credentials in the local target session. |
protected java.lang.String |
signInRemote(java.lang.String userId,
java.lang.String password,
WcmRequestMap extraParameters)
Sets the credentials in the remote target session. |
protected java.lang.String |
signInViaToken(java.lang.String userId,
java.lang.String password,
WcmRequestMap extraParameters)
Sets the credentials in the remote target session. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected WcmController controller
protected java.lang.String originSessionId
protected java.lang.String encodedSessionId
protected java.lang.String originScheme
protected java.lang.String originIP
protected java.lang.String originPort
protected java.lang.String userId
protected java.lang.String errorMessage
protected java.lang.Exception lastException
protected boolean noSession
protected java.lang.String targetUrl
protected java.lang.String targetBase
protected boolean disableInternalToken
protected java.lang.Boolean localSession
protected WcmException sessionInvalidException
protected int maxErrorLength
Constructor Detail |
public WcmSignInProcessor(WcmController c, java.lang.String originIPValue, java.lang.String originPortValue, java.lang.String originSessionIdValue, java.lang.String targetBaseValue, java.lang.String targetUrlValue, java.lang.String encodedSessionIdValue)
public WcmSignInProcessor(WcmController c, java.lang.String originIPValue, java.lang.String originPortValue, java.lang.String originSessionIdValue, java.lang.String originSchemeValue, java.lang.String encodedSessionIdValue)
Method Detail |
protected void configure(WcmController c, java.lang.String originIP, java.lang.String originPort, java.lang.String originSessionId, java.lang.String originScheme, java.lang.String encodedSessionId)
c
- - The controller object from the calling module.originIP
- - The origin IP for where the target session is located.originPort
- - The origin port for where the target session is located.originSessionId
- - The origin session ID for where the target session is located.originScheme
- - The origin scheme for where the target session is located. Typically "http".encodedSessionId
- - (optional) The URL encoded session as returned from response.encodeURL("")public void setDisableInternalToken(boolean value)
public int getMaxErrorLength()
public int setMaxErrorLength(int newValue)
public java.lang.String getUserID()
public java.lang.String getErrorMessage()
public java.lang.Exception getException()
public boolean getNoSession()
public java.lang.String getTargetBase()
public java.lang.String getTargetUrl()
public void clearStatus()
public java.lang.String getLocalSessionId(javax.servlet.http.HttpServletRequest request)
request
- - The current HttpServletRequest object.
public boolean doSignInWork(java.lang.String userId, java.lang.String password, WcmRequestMap extraParameters, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
userId
- - The user ID to sign in as.password
- - The password to use to sign in.extraParameters
- - Any additional parameters to send to the sign in policy object.request
- - The current HttpServletRequest object.response
- - The current HttpServletResponse object.
java.lang.Exception
public boolean isSessionLocal(javax.servlet.http.HttpServletRequest request) throws java.lang.Exception
java.lang.Exception
public boolean isServerLocal() throws java.lang.Exception
java.lang.Exception
public java.lang.String signIn(javax.servlet.http.HttpServletRequest request, java.lang.String userId, java.lang.String password, WcmRequestMap extraParameters) throws java.lang.Exception
request
- - The current HttpServletRequest object.userId
- - The user ID to sign in as.password
- - The password to use to sign in.extraParameters
- - Any additional parameters to send to the sign in policy object.
java.lang.Exception
protected java.lang.String signInRemote(java.lang.String userId, java.lang.String password, WcmRequestMap extraParameters) throws java.lang.Exception
userId
- - The user ID to sign in as.password
- - The password to use to sign in.extraParameters
- - Any additional parameters to send to the sign in policy object.
java.lang.Exception
protected java.lang.String signInViaToken(java.lang.String userId, java.lang.String password, WcmRequestMap extraParameters) throws java.lang.Exception
userId
- - The user ID to sign in as.password
- - The password to use to sign in.extraParameters
- - Any additional parameters to send to the sign in policy object.
java.lang.Exception
public java.lang.String signInLocal(java.lang.String user, java.lang.String password, WcmRequestMap extraParameters) throws java.lang.Exception
user
- - The user ID to sign in as.password
- - The password to use to sign in.extraParameters
- - Any additional parameters to send to the sign in policy object.
java.lang.Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |