com.ibm.ecm.extension

Class PluginODAuthenticationService

java.lang.Object

com.ibm.ecm.extension.PluginODAuthenticationService

public abstract class PluginODAuthenticationService
extends java.lang.Object

Subclass to provide a custom service used for Content Manager OnDemand single sign-on (SSO). This is an optional service that will be called when SSO is enabled on a Content Manager OnDemand server. The result of the service will be the information passed through the Content Manager OnDemand Web Enablement Kit "passThru" API.

Since:

2.0.2

Constructor Summary

Constructors

Constructor and Description
PluginODAuthenticationService()

Method Summary

Modifier and Type	Method and Description
abstract byte[]	execute(PluginServiceCallbacks callbacks, javax.servlet.http.HttpServletRequest request) Performs the action of this service.
abstract java.lang.String	getId() Returns the unique identifier for this service.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginODAuthenticationService

public PluginODAuthenticationService()

Method Detail

getId

public abstract java.lang.String getId()

Returns the unique identifier for this service.

Important: This identifier is used in URLs so it must contain only alphanumeric characters.

Returns:

A String that is used to identify the service.

execute

public abstract byte[] execute(PluginServiceCallbacks callbacks,
                               javax.servlet.http.HttpServletRequest request)
                        throws java.lang.Exception

Performs the action of this service.

Parameters:

callbacks - An instance of the PluginServiceCallbacks class that contains several functions that can be used by the service. These functions provide access to the plug-in configuration and content server APIs.

request - The HttpServletRequest object that provides the request. The service can access the invocation parameters from the request.

Returns:

Returns a byte array to be passed to the Content Manager OnDemand Server.

Throws:

java.lang.Exception - For exceptions that occur when the service is running. If the logging level is high enough to log errors, information about the exception is logged by IBM Content Navigator.