com.highdeal.admin.hci

Class DeleteUserSessionOp

java.lang.Object

com.highdeal.admin.hci.DeleteUserSessionOp

All Implemented Interfaces:

MessageOperation, XMLMarshallable

public class DeleteUserSessionOp
extends Object
implements MessageOperation

This operation allows you to delete a user session from the list of running user sessions.

This operation can be used to delete a user session linked to a tool (user interface) that has been terminated abnormally and could not disconnect properly from the server system, thus preventing a new session to be opened with the same SAP CC user and tool.

The identifier of the user session to delete must be specified in the sessionId attribute of the operation.

If the session identifier of the user session is not set, or if the session identifier does not correspond to a running user session, an InvalidDeletionException with the reason does_not_exist will be thrown.

Operation Result

DeleteUserSessionResult

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="deleteUserSession">
   <xs:complexType>
     <xs:attribute name="sessionId" type="xs:string" use="optional" />
     <xs:attribute name="login" type="xs:string" use="optional" />
     <xs:attribute name="toolName" type="xs:string" use="optional"/>
   </xs:complexType>
 </xs:element>

Operation Availability

You can send this operation request in HCI messages to the following final target types of instances in the connected SAP CC system:

Edition	Final Target Instances
	rater	updater	guider	bulkLoader	taxer	dispatcher
charge	No	No	No	No	No	Yes

Audit Domain

This operation is audited as part of the audit domain ADMINISTRATION

Field Summary

Fields

Modifier and Type	Field and Description
static String	OPERATION_NAME The XML tag name of this service operation: "deleteUserSession"

Constructor Summary

Constructors

Constructor and Description
DeleteUserSessionOp() Builds an empty DeleteUserSessionOp.

Method Summary

Modifier and Type	Method and Description
void	addCharacterData(String data) Adds character data to the content element.
void	addChild(String tagName, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
String	getLogin() Gets the login of the user session(s) to delete.
String	getName() Gets the XML name of the service operation.
String	getSessionId() Gets the identifier of the user session to delete.
String	getToolName() Gets the name of the tool of the user session(s) to delete.
void	marshal(XMLOutputter output) Gives an XML representation of this object, including its children.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.
void	setLogin(String login) Sets the login of the user session(s) to delete.
void	setSessionId(String sessionId) Sets the identifier of the user session to delete.
void	setToolName(String toolName) Sets the name of the tool of the user session(s) to delete.

Methods inherited from class java.lang.Object

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

Field Detail

OPERATION_NAME

public static final String OPERATION_NAME

The XML tag name of this service operation: "deleteUserSession"

See Also:

Constant Field Values

Constructor Detail

DeleteUserSessionOp

public DeleteUserSessionOp()

Builds an empty DeleteUserSessionOp.

Method Detail

getSessionId

public String getSessionId()

Gets the identifier of the user session to delete.

Returns:

The identifier of the user session to delete

setSessionId

public void setSessionId(String sessionId)

Sets the identifier of the user session to delete.

Parameters:

sessionId - The identifier of the user session to delete

getLogin

public String getLogin()

Gets the login of the user session(s) to delete.

Returns:

The login of the user session(s) to delete

setLogin

public void setLogin(String login)

Sets the login of the user session(s) to delete.

Parameters:

login - The login of the user session(s) to delete

setToolName

public void setToolName(String toolName)

Sets the name of the tool of the user session(s) to delete.

Parameters:

toolName - The name of the tool of the user session(s) to delete

getToolName

public String getToolName()

Gets the name of the tool of the user session(s) to delete.

Returns:

The name of the tool of the user session(s) to delete

getName

public String getName()

Description copied from interface: MessageOperation

Gets the XML name of the service operation. This name identifies the operation request in the HCI messages. It is used to marshal the Java object representing an HCI operation into an XML representation that can be exchanged via the HCI communication interface between your client application and the SAP CC system.

Example

• activateAll
• ping

Specified by:

getName in interface MessageOperation

Returns:

The technical name of the HCI operation

addCharacterData

public void addCharacterData(String data)

Description copied from interface: XMLMarshallable

Adds character data to the content element.

Specified by:

addCharacterData in interface XMLMarshallable

Parameters:

data - The character data to be added

addChild

public void addChild(String tagName,
                     XMLMarshallable child)

Description copied from interface: XMLMarshallable

Adds a child to the object, the child representing the marshallable object which must be added to the element.

Specified by:

addChild in interface XMLMarshallable

Parameters:

tagName - The name of tag for the child

child - The child to be added

marshal

public void marshal(XMLOutputter output)

Description copied from interface: XMLMarshallable

Gives an XML representation of this object, including its children.

Specified by:

marshal in interface XMLMarshallable

Parameters:

output - The XML output to marshal the object into

setAttributes

public void setAttributes(XMLAttributes atts)

Description copied from interface: XMLMarshallable

Sets the attributes of the XML representation of the element being processed.

Specified by:

setAttributes in interface XMLMarshallable

Parameters:

atts - The XML attributes of the current element