Package com.highdeal.hci

Class DisconnectUserOp

java.lang.Object
com.highdeal.hci.DisconnectUserOp
All Implemented Interfaces:
MessageOperation, XMLMarshallable
public class DisconnectUserOp extends 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:

Operation Result

DisconnectUserResult

Operation Failure Exceptions

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:

EditionFinal Target Instances
raterupdaterguiderbulkLoadertaxerdispatcher
chargeNoYesNoNoNoNo

  • Field Details

    • OPERATION_NAME

      public static final String OPERATION_NAME
      The XML tag name of this service operation: "disconnectUser"
      See Also:

  • Constructor Details

    • DisconnectUserOp

      public DisconnectUserOp()
      Builds an empty DisconnectUserOp.

  • Method Details

    • 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

    • getSessionId

      public String getSessionId()
      Gets the identifier of the user session to close.
      Returns:
      The identifier of the session to close

    • setSessionId

      public void setSessionId(String sessionId)
      Sets the identifier of the user session to close.
      Parameters:
      sessionId - The identifier of the session to close

    • 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