com.moximedia.aims
Class AimsRegistration

java.lang.Object
  com.moximedia.aims.AimsRegistration

public class AimsRegistration

extends java.lang.Object

Handles script level registration.

Author:

Doug Cates - www.moximedia.com

Field Summary

static int

STORAGE_METHOD_SESSION

Constructor Summary

AimsRegistration()
Creates a new instance of AimsRegistration

Method Summary

java.lang.String	getActionScript() Gets the name of the script that will be executed when the protected script is run.
java.lang.String	getInputParams() Gets the parameters to the original script when redirected to the login page as a bunch of input statements.
java.lang.String	getLoginScript() Gets the name of the login script for the protected script.
java.util.HashMap	getParams() Gets the parameters to the original script when redirected to the login page.
java.lang.String	getProtectedScript() Gets the name of the protected script.
java.lang.String	getStorageId() Gets the name of the cookie or session variable containing the user's credentials.
int	getStorageMethod() Gets the method type used for storing user credentials.
void	setActionScript(java.lang.String script) Sets the name of the script that will be executed when the protected script is run.
void	setLoginScript(java.lang.String script) Sets the name of the login script for the protected script.
void	setParams(javax.servlet.http.HttpServletRequest request) Saves the parameters to the original script when redirected to the login page.
void	setProtectedScript(java.lang.String script) Sets the name of the protected script.
void	setStorageId(java.lang.String storageId) Gets the name of the cookie or session variable containing the user's credentials.
void	setStorageMethod(int method) Sets the method type used for storing user credentials.
void	setStorageMethod(java.lang.String method) Sets the method type used for storing user credentials.
void	setXmlAttribute(java.lang.String tag, java.lang.String name, java.lang.String value) Sets one of the attributes of this object using a string value.

Methods inherited from class java.lang.Object

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

Field Detail

STORAGE_METHOD_SESSION

public static final int STORAGE_METHOD_SESSION

See Also:

Constant Field Values

Constructor Detail

AimsRegistration

public AimsRegistration()

Creates a new instance of AimsRegistration

Method Detail

getActionScript

public java.lang.String getActionScript()

Gets the name of the script that will be executed when the protected script is run. Useful for logging actions by registered users. Set to null for protected scripts that need no actions to be executed.

Returns:

The name of the script, or null if there isn't one.

setActionScript

public void setActionScript(java.lang.String script)

Sets the name of the script that will be executed when the protected script is run. Useful for logging actions by registered users. Set to null for protected scripts that need no actions to be executed.

Parameters:

script - The name of the script, or null if there isn't one.

getLoginScript

public java.lang.String getLoginScript()

Gets the name of the login script for the protected script.

Returns:

The name of the login script within the IMF directory.

setLoginScript

public void setLoginScript(java.lang.String script)

Sets the name of the login script for the protected script.

getProtectedScript

public java.lang.String getProtectedScript()

Gets the name of the protected script.

Returns:

The name of the protected script within the IMF directory.

setProtectedScript

public void setProtectedScript(java.lang.String script)

Sets the name of the protected script.

Parameters:

script - The name of the protected script within the IMF directory.

getStorageMethod

public int getStorageMethod()

Gets the method type used for storing user credentials. The storage method type can be a cookie, session variable, or a bean.

Returns:

The method type enumerator.

setStorageMethod

public void setStorageMethod(int method)

Sets the method type used for storing user credentials. The storage method type can be a cookie, session variable, or a bean.

Parameters:

method - The method type enumerator.

setStorageMethod

public void setStorageMethod(java.lang.String method)

Sets the method type used for storing user credentials. The storage method type can be a cookie, session variable, or a bean.

Parameters:

method - The method type string, Only "session" is supported at this time.

getStorageId

public java.lang.String getStorageId()

Gets the name of the cookie or session variable containing the user's credentials.

Returns:

The name of the cookie or bean.

setStorageId

public void setStorageId(java.lang.String storageId)

Gets the name of the cookie or session variable containing the user's credentials.

Parameters:

storageId - The name of the cookie or bean.

getParams

public java.util.HashMap getParams()

Gets the parameters to the original script when redirected to the login page.

Returns:

The original request parameters.

getInputParams

public java.lang.String getInputParams()

Gets the parameters to the original script when redirected to the login page as a bunch of input statements.

Returns:

The original request parameters as input statemente.

setParams

public void setParams(javax.servlet.http.HttpServletRequest request)

Saves the parameters to the original script when redirected to the login page.

Parameters:

request - The original request.

setXmlAttribute

public void setXmlAttribute(java.lang.String tag,
                            java.lang.String name,
                            java.lang.String value)

Sets one of the attributes of this object using a string value. This method should only be called from the SAX event handler.

Parameters:

tag - The XML element tag containing this attribute.

name - The XML attribute name.

value - The XML attribute value.