Package com.highdeal.hci

Class AuthenticateUserOp

java.lang.Object
com.highdeal.hci.AuthenticateUserOp
All Implemented Interfaces:
MessageOperation, XMLMarshallable
public class AuthenticateUserOp extends Object implements MessageOperation
This operation allows you to check the login and password of an SAP CC user and to retrieve the assigned roles and granted authorization objects resulting from the merge of all the roles assigned to the user.
  • If the listAuthorizations attribute is set to true, the operation response AuthenticateUserResult will contain the list of user authorizations.
  • If either the listFailures attribute is set to true or the toolName attribute is specified, the operation response will contain up to 20 failed authentication attempts since the last connection.

User Session Management

To implement the user session managment, you specify the name of the user interface that sends this operation (see the toolName option). If the user session management function is enabled, the SAP CC system checks if the maximum number of concurrent running sessions has been reached for this user and this tool.

  • If the maximum number of concurrent sessions has not been reached for the user/tool pair, a new user session is created and a session identifier is generated and returned by the SAP CC Core Server system (see AuthenticateUserResult).
  • If the maximum number of concurrent sessions has not reached for the user/tool pair, an AuthenticationFailedException with the reason session_already_exists will be thrown.

The returned session identifier can be used later in the MessageOriginator of an envelope to specify that it belongs to the user session.

A user session opened with this operation can be closed using the Disconnect User operation.

Other Related Operation

See Also:

Operation Result

AuthenticateUserResult

Operation Failure Exceptions

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="authenticateUser">
   <xs:complexType>
     <xs:attribute name="login" type="xs:string" use="required"/>
     <xs:attribute name="password" type="xs:string" use="optional"/>
     <xs:attribute name="toolName" type="xs:string" use="optional"/>
     <xs:attribute name="version" type="xs:string" use="optional"/>
     <xs:attribute name="listFailures" type="xs:boolean" use="optional" default="false"/>
     <xs:attribute name="listAuthorizations" type="xs:boolean" use="optional" default="false"/>
     <xs:attribute name="listObjectAccessRules" type="xs:boolean" use="optional" default="false"/>
   </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
chargeNoYesNoNoNoYes

  • Field Details

    • OPERATION_NAME

      public static final String OPERATION_NAME
      The value of this constant is the XML tag name of this operation: "authenticateUser".
      See Also:

  • Constructor Details

    • AuthenticateUserOp

      public AuthenticateUserOp()
      Creates an authentication operation.

  • 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

    • getLoginID

      public String getLoginID()
      Returns the login of the SAP CC user that is to be authenticated.
      Returns:
      The login of the SAP CC user that is to be authenticated

    • setLoginID

      public void setLoginID(String id)
      Sets the login of the SAP CC user that is to be authenticated.
      Parameters:
      id - The login of the SAP CC user that is to be authenticated

    • setPassword

      public void setPassword(String password)
      Sets the password of the SAP CC user that is to be authenticated.
      Parameters:
      password - The password of the SAP CC user that is to be authenticated

    • getPassword

      public String getPassword()
      Returns the password of the SAP CC user that is to be authenticated.
      Returns:
      The password of the SAP CC user that is to be authenticated

    • setToolName

      public void setToolName(String toolName)
      Sets the name of the tool (user interface) sending the operation.
      Parameters:
      toolName - The name of the tool sending the operation

    • getToolName

      public String getToolName()
      Gets the name of the tool (user interface) sending the operation.
      Returns:
      The name of the tool sending the operation

    • getVersion

      public String getVersion()
      Gets the version of the client sending the operation.
      Returns:
      The version of the client sending the operation

    • setListFailures

      public void setListFailures(boolean listFailures)
      Sets whether the operation must list the failed authentication attempts.
      Parameters:
      listFailures - Flag: true if the operation must list the failed authentication attempts, false otherwise

    • getListFailures

      public boolean getListFailures()
      Gets whether the operation must list the failed authentication attempts.
      Returns:
      true if the operation must list the failed authentication attempts, false otherwise

    • getListAuthorizations

      public boolean getListAuthorizations()
      Gets whether the operation must list the authorizations
      Returns:
      true if the operation must list the authorizations, false otherwise

    • setListAuthorizations

      public void setListAuthorizations(boolean listAuthorizations)
      Sets whether the operation must list the authorizations
      Parameters:
      listAuthorizations - true if the operation must list the authorizations, false otherwise

    • getListObjectAccessRules

      public boolean getListObjectAccessRules()
      Gets whether the operation must list the object access rules
      Returns:
      true if the operation must list the object access rules, false otherwise

    • setListObjectAccessRules

      public void setListObjectAccessRules(boolean oars)
      Sets whether the operation must list the object access rules
      Parameters:
      oars - true if the operation must list the object access rules, false otherwise

    • 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

    • addCharacterData

      public void addCharacterData(String cData)
      Description copied from interface: XMLMarshallable
      Adds character data to the content element.
      Specified by:
      addCharacterData in interface XMLMarshallable
      Parameters:
      cData - 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