com.tivoli.am.eb.web.eaidemo
Class EAIDemoServerConfig

java.lang.Object
  extended bycom.tivoli.am.eb.web.eaidemo.EAIDemoServerConfig

public class EAIDemoServerConfig
extends java.lang.Object

Class representing EAI servlet configuration parameters. The parameters are stored as servlet context parameters and can be changed by editing the web.xml file for this application.

Author:
Tivoli Systems

Field Summary
static short DEMO_TYPE_PAC
          Indicates the advanced demo, returning only PAC headers and requiring configuration through PdJrteCfg and SvrSslCfg.
static short DEMO_TYPE_USER_ID
          Indicates the simple demo, returning only User ID headers.
 
Method Summary
 java.util.Properties getConfig()
          Returns the properties object representing the config file.
 java.lang.String getDefaultAuthLevelValue()
          Returns the value corresponding to the eai-auth-level header.
 java.lang.String getDefaultRedirectURL()
          Returns the value of the URL to which WebSEAL should redirect users upon successful authentication.
 java.lang.String getDefaultUser()
          The TAM user that all EAI demo logins map to.
 java.lang.String getEAIAuthLevelHeader()
          Returns the name of the header that should be used to indicate authentication level.
 java.lang.String getEAIPACHeader()
          Returns the name of the header that should be used to indicate the user PAC.
 java.lang.String getEAIPACSvcHeader()
          Returns the name of the header that should be used to indicate the PAC service control header.
 java.lang.String getEAIRedirURLHeader()
          Returns the name of the header that should be used to indicate the URL to which WebSEAL will redirect users upon successful authentication.
 java.lang.String getEAIUserIDHeader()
          Returns the name of the header that should be used to indicate the user ID for WebSEAL to use when constructing a credential for the user.
 java.lang.String getEAIxattrsHeader()
          Returns the name of the header that should be used to indicate EAI extended attributes.
static EAIDemoServerConfig getInstance(javax.servlet.ServletContext ctx)
          Singleton pattern to return the common configuration object.
 java.net.URL getPDPermPropertiesURL()
          Returns the URL of the PDJRTE configuration file.
 void setDefaultAuthLevelValue(java.lang.String value)
          Returns the value corresponding to the eai-auth-level header.
 void setDefaultRedirectURL(java.lang.String value)
          Returns the value of the URL to which WebSEAL should redirect users upon successful authentication.
 void setDefaultUser(java.lang.String value)
          The TAM user that all EAI demo logins map to.
 void setEAIAuthLevelHeader(java.lang.String value)
          Returns the name of the header that should be used to indicate authentication level.
 void setEAIPACHeader(java.lang.String value)
          Returns the name of the header that should be used to indicate the user PAC.
 void setEAIPACSvcHeader(java.lang.String value)
          Returns the name of the header that should be used to indicate the PAC service control header.
 void setEAIRedirURLHeader(java.lang.String value)
          Returns the name of the header that should be used to indicate the URL to which WebSEAL will redirect users upon successful authentication.
 void setEAIUserIDHeader(java.lang.String value)
          Returns the name of the header that should be used to indicate the user ID for WebSEAL to use when constructing a credential for the user.
 void setEAIxattrsHeader(java.lang.String value)
          Returns the name of the header that should be used to indicate EAI extended attributes.
 void setPDPermPropertiesURL(java.lang.String value)
          Returns the URL of the PDJRTE configuration file.
 void storeConfig()
          Saves the config file to disk.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEMO_TYPE_USER_ID

public static final short DEMO_TYPE_USER_ID
Indicates the simple demo, returning only User ID headers.

See Also:
Constant Field Values

DEMO_TYPE_PAC

public static final short DEMO_TYPE_PAC
Indicates the advanced demo, returning only PAC headers and requiring configuration through PdJrteCfg and SvrSslCfg.

See Also:
Constant Field Values
Method Detail

getInstance

public static EAIDemoServerConfig getInstance(javax.servlet.ServletContext ctx)
                                       throws javax.servlet.ServletException
Singleton pattern to return the common configuration object.

Parameters:
ctx - the ServletContext for this application.
Returns:
The config singleton, or a new config object if the singleton is null.
Throws:
javax.servlet.ServletException - if there's a problem with the config.

getConfig

public java.util.Properties getConfig()
Returns the properties object representing the config file.

Returns:
the properties object.

setDefaultAuthLevelValue

public void setDefaultAuthLevelValue(java.lang.String value)
Returns the value corresponding to the eai-auth-level header.

Parameters:
value - the default auth level if the user doesn't supply one.

getDefaultAuthLevelValue

public java.lang.String getDefaultAuthLevelValue()
Returns the value corresponding to the eai-auth-level header.

Returns:
The auth level, a string between 1 and 5; null if the parameter does not exist.

setDefaultRedirectURL

public void setDefaultRedirectURL(java.lang.String value)
Returns the value of the URL to which WebSEAL should redirect users upon successful authentication.

Parameters:
value - the default redirect url to set.

getDefaultRedirectURL

public java.lang.String getDefaultRedirectURL()
Returns the value of the URL to which WebSEAL should redirect users upon successful authentication.

Returns:
A String representation of the URL for inclusion in the reponse headers.

setDefaultUser

public void setDefaultUser(java.lang.String value)
The TAM user that all EAI demo logins map to. This user must exist in the TAM registry.

Parameters:
value - the username that will be used for credential generation.

getDefaultUser

public java.lang.String getDefaultUser()
The TAM user that all EAI demo logins map to. This user must exist in the TAM registry.

Returns:
The user ID; null if the parameter does not exist.

setEAIAuthLevelHeader

public void setEAIAuthLevelHeader(java.lang.String value)
Returns the name of the header that should be used to indicate authentication level.

Parameters:
value - the name of the auth level header.

getEAIAuthLevelHeader

public java.lang.String getEAIAuthLevelHeader()
Returns the name of the header that should be used to indicate authentication level.

Returns:
The header name; null if the parameter does not exist.

setEAIPACHeader

public void setEAIPACHeader(java.lang.String value)
Returns the name of the header that should be used to indicate the user PAC.

Parameters:
value - the name of the PAC header.

getEAIPACHeader

public java.lang.String getEAIPACHeader()
Returns the name of the header that should be used to indicate the user PAC.

Returns:
The header name; null if the parameter does not exist.

setEAIPACSvcHeader

public void setEAIPACSvcHeader(java.lang.String value)
Returns the name of the header that should be used to indicate the PAC service control header.

Parameters:
value - the name of the PAC service control header.

getEAIPACSvcHeader

public java.lang.String getEAIPACSvcHeader()
Returns the name of the header that should be used to indicate the PAC service control header.

Returns:
The header name; null if the parameter does not exist.

setEAIRedirURLHeader

public void setEAIRedirURLHeader(java.lang.String value)
Returns the name of the header that should be used to indicate the URL to which WebSEAL will redirect users upon successful authentication.

Parameters:
value - the name of the redirection url header.

getEAIRedirURLHeader

public java.lang.String getEAIRedirURLHeader()
Returns the name of the header that should be used to indicate the URL to which WebSEAL will redirect users upon successful authentication.

Returns:
The header name; null if the parameter does not exist.

setEAIUserIDHeader

public void setEAIUserIDHeader(java.lang.String value)
Returns the name of the header that should be used to indicate the user ID for WebSEAL to use when constructing a credential for the user.

Parameters:
value - the name of the user id header.

getEAIUserIDHeader

public java.lang.String getEAIUserIDHeader()
Returns the name of the header that should be used to indicate the user ID for WebSEAL to use when constructing a credential for the user.

Returns:
The header name; null if the parameter does not exist.

setEAIxattrsHeader

public void setEAIxattrsHeader(java.lang.String value)
Returns the name of the header that should be used to indicate EAI extended attributes.

Parameters:
value - the name of the extended attributes header.

getEAIxattrsHeader

public java.lang.String getEAIxattrsHeader()
Returns the name of the header that should be used to indicate EAI extended attributes.

Returns:
The header name; null if the parameter does not exist.

setPDPermPropertiesURL

public void setPDPermPropertiesURL(java.lang.String value)
Returns the URL of the PDJRTE configuration file.

Parameters:
value - the url to the PDJRTE configuration file.

getPDPermPropertiesURL

public java.net.URL getPDPermPropertiesURL()
                                    throws java.net.MalformedURLException
Returns the URL of the PDJRTE configuration file.

Returns:
The location of the configuration file in URL format.
Throws:
java.net.MalformedURLException - If the configuration file contains an incorrectly formatted URL.

storeConfig

public void storeConfig()
Saves the config file to disk.



Copyright © 2004 IBM Corp. All Rights Reserved.