Package com.highdeal.hci

Class AuthenticateUserResult

java.lang.Object
com.highdeal.hci.AuthenticateUserResult
All Implemented Interfaces:
OperationResult, XMLMarshallable
public class AuthenticateUserResult extends Object implements OperationResult
This class represents the result of the Authenticate User operation; It contains the definition of the authenticated SAP CC user with granted authorization.

If the advanced password management feature is enabled, this result will also contain the time left before the expiration of the password of the user.

If user sessions are enabled and if a tool name was specified in the corresponding Authenticate User operation request, this result contains a session identifier generated by the connected SAP CC system, which identifies a session for the SAP CC user and tool specified in the authentication operation.

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

If the corresponding Authenticate User operation has the attribute toolName set or has the attribute listFailures set to true, the authentication result will also contain up to 20 failed authentication attempts which occurred since the last successful authentication with a similar configuration, starting from the oldest ones.

Configuration

System Configuration

The result depends on the values of the PASSWORD_MANAGEMENT_ENABLED and USER_SESSION_ENABLED system parameters.

Use the SAP CC Admin+ user interface and the get>/code> command to retrieve the current values in the running SAP CC system.

Additional Information

Consult the SAP CC Configuration Guide for more information about the settings for the management of SAP CC users.

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="authenticateUserResult">
   <xs:complexType>
     <xs:sequence>
       <xs:element ref="user" minOccurs="0" maxOccurs="1"/>
       <xs:element ref="authorization" minOccurs="0" maxOccurs="unbounded"/>
       <xs:element ref="objectAccessRule" minOccurs="0" maxOccurs="unbounded"/>
       <xs:element name="failedAuthentication" minOccurs="0" maxOccurs="20">
         <xs:complexType>
           <xs:attribute name="recordDate" type="xs:dateTime" use="required" />
           <xs:attribute name="sourceAddress" type="xs:string" use="required" />
         </xs:complexType>
       </xs:element>
     </xs:sequence>
     <xs:attribute name="passwordExpiration" type="xs:decimal"/>
   </xs:complexType>
 </xs:element>

  • Field Details

  • Constructor Details

    • AuthenticateUserResult

      public AuthenticateUserResult()

  • Method Details

    • getUser

      public UserModel getUser()
      Gets the user definition
      Returns:
      The user definition

    • getPasswordExpiration

      public int getPasswordExpiration()
      Gets the delay before expiration of the password
      Returns:
      The delay before expiration of the password

    • getOperandReference

      public String getOperandReference()
      Description copied from interface: OperationResult
      Gets the code or the reference (if no code exists) that identifies the operand of the operation request; If the operation is not auditable, the operand reference is null.
      Specified by:
      getOperandReference in interface OperationResult
      Returns:
      The operand reference of the operation result

    • setUser

      public void setUser(XMLMarshallable userModel)
      Sets the user definition
      Parameters:
      userModel - The user definition

    • getAuthorizations

      public List<AuthorizationModel> getAuthorizations()
      Gets the list of authorization identifiers of the SAP CC user
      Returns:
      The list of Activity identifiers of the user

    • getObjectAccessRules

      public List<ObjectAccessRuleModel> getObjectAccessRules()
      Gets the list of object access rules of the SAP CC user
      Returns:
      The list of object access rules of the user

    • getSessionId

      public String getSessionId()
      Gets the user session identifier
      Returns:
      The user session identifier

    • setSessionId

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

    • setPasswordExpiration

      public void setPasswordExpiration(int passwordExpiration)
      Sets the delay before expiration of the password
      Parameters:
      passwordExpiration - The delay before expiration of the password

    • getFailedAuthentications

      public Vector<AuthenticateUserResult.FailedAuthenticationModel> getFailedAuthentications()
      Gets the list of failed authentication attempts
      Returns:
      The list of failed authentication attempts

    • setFailedAuthentications

      public void setFailedAuthentications(Vector<AuthenticateUserResult.FailedAuthenticationModel> failedAuthentications)
      Sets the list of failed authentication attempts
      Parameters:
      failedAuthentications - The list of failed authentication attempts

    • 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