com.sage.orion.sdata.servlet.accpac
Class CloseCRMSessionOperation

java.lang.Object
  extended by com.sage.orion.sdata.servlet.BaseServiceOperation
      extended by com.sage.orion.sdata.servlet.accpac.CloseSessionOperation
          extended by com.sage.orion.sdata.servlet.accpac.CloseCRMSessionOperation
All Implemented Interfaces:
ServiceOperation

public class CloseCRMSessionOperation
extends CloseSessionOperation

The CloseCRMSessionOperation class provides the ability to close a session by extending the CloseSessionOperation class to allow for sessions opened by CRM.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.sage.orion.sdata.servlet.BaseServiceOperation
BaseServiceOperation.FieldData, BaseServiceOperation.FieldNames
 
Field Summary
 
Fields inherited from class com.sage.orion.sdata.servlet.accpac.CloseSessionOperation
LOGGER
 
Constructor Summary
CloseCRMSessionOperation()
           
 
Method Summary
 java.lang.String getDescription()
          Get a description of the service operation, for use in service lists
 java.lang.String getName()
          Get the full name of this service operation, i.e.
protected  java.lang.String getOperationName()
          Get the short name of this service operation, i.e.
protected  java.lang.String getPath()
          Get the URL to this service operation.
protected  void removeFromSessionMap(SDataRequest request, java.lang.String sessionID)
           removes the given client session GUID from whichever session map is holding it, using the request to find the map.
 
Methods inherited from class com.sage.orion.sdata.servlet.accpac.CloseSessionOperation
createRequestFields, createResponseFields, createTemplateFields, execute
 
Methods inherited from class com.sage.orion.sdata.servlet.BaseServiceOperation
getResponseFields, getSchema, handleRequest, shutdown
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CloseCRMSessionOperation

public CloseCRMSessionOperation()
Method Detail

getOperationName

protected java.lang.String getOperationName()
Description copied from class: BaseServiceOperation
Get the short name of this service operation, i.e. the operation name which is not prefixed with resource name(s)

Overrides:
getOperationName in class CloseSessionOperation
Returns:
service operation name

getPath

protected java.lang.String getPath()
Description copied from class: BaseServiceOperation
Get the URL to this service operation.

Overrides:
getPath in class CloseSessionOperation
Returns:
the URL to this service operation

getName

public java.lang.String getName()
Description copied from interface: ServiceOperation
Get the full name of this service operation, i.e. the operation name prefixed with resource name(s) to make it unique in the schema

Specified by:
getName in interface ServiceOperation
Overrides:
getName in class CloseSessionOperation
Returns:
a non-null String containing the full name of the service operation

getDescription

public java.lang.String getDescription()
Description copied from interface: ServiceOperation
Get a description of the service operation, for use in service lists

It defaults to the full name of this service operation, i.e. the operation name prefixed with resource name(s)

The description should be in the language required by the user

Specified by:
getDescription in interface ServiceOperation
Overrides:
getDescription in class CloseSessionOperation
Returns:
a non-null String containing the description of the service operation

removeFromSessionMap

protected void removeFromSessionMap(SDataRequest request,
                                    java.lang.String sessionID)

removes the given client session GUID from whichever session map is holding it, using the request to find the map.

The base implementation removes the GUID from the HttpSessionMap associated with the request's HttpSession.

Override this method to specify a different method for locating and removing the GUID

The removeFromSessionMap(com.sage.orion.sdata.servlet.SDataRequest, java.lang.String) implementation allows for the session GUID being still on the CRMSessionMap rather than on a particular HttpSession.

Overrides:
removeFromSessionMap in class CloseSessionOperation
Parameters:
request - the request being served, which can be used to locate the map holding the GUID
sessionID - the client session GUID to remove


Copyright © 2011 Sage Software, Inc. All rights reserved.