com.highdeal.hci

Class DisconnectUserOp

java.lang.Object

com.highdeal.hci.DisconnectUserOp

All Implemented Interfaces:

MessageOperation, XMLMarshallable

public class DisconnectUserOp
extends java.lang.Object
implements MessageOperation

This operation allows you to close a user session that has been previously opened using the Authenticate User operation.

The identifier of the user session must be specified in the operation, and must be the same as the session identifier present in the originator of the enclosing envelope. Otherwise an AuthenticationFailedException is thrown with the reason invalid_session_id.

Other Related Operation

Authenticate User operation

See Also:

AuthenticateUserOp

Operation Result

DisconnectUserResult

Operation Failure Exception

AuthenticationFailedException

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="disconnectUser">
   <xs:complexType>
     <xs:attribute name="sessionId" type="xs:string" use="required"/>
   </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	Yes	No	No	No	No

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OPERATION_NAME The XML tag name of this service operation: "disconnectUser"

Constructor Summary

Constructors

Constructor and Description
DisconnectUserOp() Builds an empty DisconnectUserOp.

Method Summary

Modifier and Type	Method and Description
void	addCharacterData(java.lang.String data) Adds character data to the content element.
void	addChild(java.lang.String tagName, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
java.lang.String	getName() Gets the XML name of the service operation.
java.lang.String	getSessionId() Gets the identifier of the user session to close.
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	setSessionId(java.lang.String sessionId) Sets the identifier of the user session to close.

Methods inherited from class java.lang.Object

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

Field Detail

OPERATION_NAME

public static final java.lang.String OPERATION_NAME

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

See Also:

Constant Field Values

Constructor Detail

DisconnectUserOp

public DisconnectUserOp()

Builds an empty DisconnectUserOp.

Method Detail

getName

public java.lang.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

getSessionId

public java.lang.String getSessionId()

Gets the identifier of the user session to close.

Returns:

The identifier of the session to close

setSessionId

public void setSessionId(java.lang.String sessionId)

Sets the identifier of the user session to close.

Parameters:

sessionId - The identifier of the session to close

addCharacterData

public void addCharacterData(java.lang.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(java.lang.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