com.filenet.wcm.toolkit.server.base
Interface WcmSignInPolicyInterface

All Known Implementing Classes:
WcmSignInPolicy

public interface WcmSignInPolicyInterface

The interface used to define sign-in behavior in a custom controller.


Method Summary
 boolean doSignIn(javax.servlet.http.HttpServletResponse response, java.lang.String requestedPage)
          Do SignIn action.
 java.lang.String getLoginRoutingInfo()
          Deprecated. - relocating this functionality WcmController.
 boolean isSignedIn()
          Implement and return true if the session has valid credentials objects.
 java.lang.String setCredentials(java.lang.String user, java.lang.String password, WcmRequestMap extraParameters)
          Set the credentials.
 

Method Detail

isSignedIn

public boolean isSignedIn()
                   throws java.lang.Exception
Implement and return true if the session has valid credentials objects.

Returns:
boolean true or false.
Throws:
java.lang.Exception

doSignIn

public boolean doSignIn(javax.servlet.http.HttpServletResponse response,
                        java.lang.String requestedPage)
                 throws java.lang.Exception
Do SignIn action. Typically this is to redirect to a sign-in page. Return true if the sign in action did a redirect.

Parameters:
response - - The current HttpServletResponse object.
requestedPage - - The page name that the user was attempting to use. Pathing should be relative to the application root.
Returns:
boolean value of whether or not there was a redirect.
Throws:
java.lang.Exception

setCredentials

public java.lang.String setCredentials(java.lang.String user,
                                       java.lang.String password,
                                       WcmRequestMap extraParameters)
                                throws java.lang.Exception
Set the credentials. After this call completes, isSignedIn should return true.

Parameters:
user - - The user name.
password - - The user's password.
extraParameters - - Any additional parameters such as appId or domain, or others.
Returns:
String value of the page to redirect to, if successful.
Throws:
java.lang.Exception

getLoginRoutingInfo

public java.lang.String getLoginRoutingInfo()
                                     throws java.lang.Exception
Deprecated. - relocating this functionality WcmController.

Throws:
java.lang.Exception


© Copyright IBM Corp. 2002, 2007. All Rights Reserved.