Session Scheme API Methods

Administration Guide › SPS APIs › Session Scheme API › Overview of Session Scheme API Processing › Session Scheme API Methods

Session Scheme API Methods

The session scheme API class consists of the following methods:

Return Value	Method	Notes
Boolean	acceptsCookies()	Retrieves the value of the acceptFlag from the accepts_smsession_cookies parameter of the session scheme in the server.conf file and returns a value indicating whether this scheme supports SiteMinder SMSESSION cookies.
abstract java.lang.String	createKeyFromRequest(HttpServletRequest req)	Executes code to retrieve values needed to create a new session key from the request.
abstract java.lang.String	getKeyFromRequest(HttpServletRequest req)	Retrieves the session key from a request.
java.lang.String	getName()	Retrieves the name of the custom session scheme as defined in the server.conf file.
abstract Boolean	isValidRequest(HttpServletRequest req)	Evaluates if the request for this session scheme is valid.
abstract int	onSessionCreate(java.lang.String id, HttpServletRequest req, HttpServletResponse resp)	Hook that is available on the event of session creation.
java.lang.String	onSessionCreateRedirect(java.lang.String id, java.lang.String url, HttpServletRequest req, HttpServletResponse resp)	Hook that is available on the event of session creation for rewritable schemes.
abstract void	onSessionLogOut(HttpServletRequest req, HttpServletResponse resp)	Hook that is available at the event of a session termination (logout).
abstract void	onSessionUpdate(HttpServletRequest req, HttpServletResponse resp)	Hook that is available on the event of session updates. This method is only for internal use.
static Boolean	usingDefaultSessionScheme(HttpServlet Request req)	Helper method for recognizing that a request is using the default session scheme.

Implement a Custom Session Scheme

Use the following procedure to implement a custom session scheme.

To implement a custom session scheme using the session scheme API

Review the sample code for the IP address session scheme in IP Address Session Scheme.
Write source code for your session scheme.
If you are creating a rewritable session scheme, you must implement the rewritable interface.
Ensure that your system CLASSPATH includes the following:
- proxycore.jar which contains the session scheme API
- JDK version 1.4 or greater jar files
- sps_home/Tomcat/server/lib jar files
Compile the session scheme.
Do one of the following:
- Create a .jar file that contains your custom session schemes then copy the .jar file to the directory sps_home/Tomcat/server/lib.
- Add the class files for your custom session scheme to the sps_home/Tomcat/server/classes directory then configure scheme in the SPS server.conf file.
Restart the SPS.

Email CA Technologies about this topic