com.filenet.wcm.apps.server.util
Class WcmISSignInPolicy

java.lang.Object
  extended bycom.filenet.wcm.toolkit.server.base.WcmSignInPolicy
      extended bycom.filenet.wcm.apps.server.util.WcmISSignInPolicy
All Implemented Interfaces:
com.filenet.wcm.toolkit.server.base.WcmSignInPolicyInterface

public class WcmISSignInPolicy
extends com.filenet.wcm.toolkit.server.base.WcmSignInPolicy

This is the IS sign in policy.


Field Summary
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmSignInPolicy
bootstrap, bootstrapPage, bootstrapRequired, controller, dataStore, FIRST_PAGE_KEY, isTokenEnabled, USER_TOKEN_APPID
 
Constructor Summary
protected WcmISSignInPolicy()
           
  WcmISSignInPolicy(com.filenet.wcm.toolkit.server.base.WcmController c, java.lang.String sslProtocolValue, java.lang.String sslHostValue, java.lang.String guestUserValue, java.util.Vector routerInfoValues, java.lang.String bootstrapPageValue)
          The constructor.
 
Method Summary
protected  WcmISServerCredentials createISServerCredentials(com.filenet.wcm.toolkit.server.util.WcmDataStore ds, WcmISServer isServer, java.lang.String user, java.lang.String password)
           
 boolean doSignIn(javax.servlet.http.HttpServletResponse response, java.lang.String requestedPage)
          Do SignIn action.
 boolean isSignedIn()
          Detects whether or not the user is signed in.
 java.lang.String setCredentials(java.lang.String user, java.lang.String password, com.filenet.wcm.toolkit.server.util.WcmRequestMap extraParameters)
          Set the credentials.
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmSignInPolicy
configureServerCredentials, configureServerCredentials, createServerCredentials, createServerCredentials, createServerCredentials, encodeTokenException, getDataStore, getDestinationPage, getEncodedSessionId, getHttpsUrl, getHttpUrl, getLocalIP, getLocalPort, getLoginRoutingInfo, getSignInURL
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WcmISSignInPolicy

protected WcmISSignInPolicy()

WcmISSignInPolicy

public WcmISSignInPolicy(com.filenet.wcm.toolkit.server.base.WcmController c,
                         java.lang.String sslProtocolValue,
                         java.lang.String sslHostValue,
                         java.lang.String guestUserValue,
                         java.util.Vector routerInfoValues,
                         java.lang.String bootstrapPageValue)
                  throws java.lang.Exception
The constructor. It contains several configuration parameters described below.

Parameters:
c - - The instance of WcmController instaniating this object.
sslProtocolValue - - The ssl protocol string (i.e. https).
sslHostValue - - The ssl host value. Specify null if you're not doing secure sign-in. Otherwise specify a "host:port".
guestUserValue - - The guest user name or null if no guest is specified.
routerInfoValues - - A vector containing any workflow router host:port values that should be tried for connecting to workflow.
bootstrapPageValue - - Optional. If your application requires bootstrap setup, specify the JSP page here. Otherwise, specify null.
Throws:
java.lang.Exception
Method Detail

isSignedIn

public boolean isSignedIn()
                   throws java.lang.Exception
Detects whether or not the user is signed in.

Returns:
true if the session is authenticated, otherwise 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. Redirects to the sign in page when credentials are needed.

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

createISServerCredentials

protected WcmISServerCredentials createISServerCredentials(com.filenet.wcm.toolkit.server.util.WcmDataStore ds,
                                                           WcmISServer isServer,
                                                           java.lang.String user,
                                                           java.lang.String password)
                                                    throws java.lang.Exception
Throws:
java.lang.Exception

setCredentials

public java.lang.String setCredentials(java.lang.String user,
                                       java.lang.String password,
                                       com.filenet.wcm.toolkit.server.util.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


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