com.highdeal.hci
Class AuthenticateUserResult

java.lang.Object
  com.highdeal.hci.AuthenticateUserResult

All Implemented Interfaces:

OperationResult, XMLMarshallable

public class AuthenticateUserResult
extends java.lang.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, the authentication result will also contain any failed authentication attempts which occurred since the last successful authentication with this attribute set.

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 name="failedAuthentication" minOccurs="0" maxOccurs="unbounded">
         <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>

Nested Class Summary

static class

AuthenticateUserResult.FailedAuthenticationModel Represents a failed authentication attempt, including a record date and a source address.

Field Summary

static java.lang.String

OPERATION_NAME

Constructor Summary

AuthenticateUserResult()

Method Summary

void	addCharacterData(java.lang.String cData) 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.util.List<AuthorizationModel>	getAuthorizations() Gets the list of authorization identifiers of the SAP CC user
java.util.Vector<AuthenticateUserResult.FailedAuthenticationModel>	getFailedAuthentications() Gets the list of failed authentication attempts
java.lang.String	getOperandReference() 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.
int	getPasswordExpiration() Gets the delay before expiration of the password
java.lang.String	getSessionId() Gets the user session identifier
UserModel	getUser() Gets the user definition
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	setFailedAuthentications(java.util.Vector<AuthenticateUserResult.FailedAuthenticationModel> failedAuthentications) Sets the list of failed authentication attempts
void	setPasswordExpiration(int passwordExpiration) Sets the delay before expiration of the password
void	setSessionId(java.lang.String sessionId) Sets the user session identifier
void	setUser(XMLMarshallable userModel) Sets the user definition

Methods inherited from class java.lang.Object

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

Field Detail

OPERATION_NAME

public static final java.lang.String OPERATION_NAME

See Also:

Constant Field Values

Constructor Detail

AuthenticateUserResult

public AuthenticateUserResult()

Method Detail

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 java.lang.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 java.util.List<AuthorizationModel> getAuthorizations()

Gets the list of authorization identifiers of the SAP CC user

Returns:

The list of Activity identifiers of the user

getSessionId

public java.lang.String getSessionId()

Gets the user session identifier

Returns:

The user session identifier

setSessionId

public void setSessionId(java.lang.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 java.util.Vector<AuthenticateUserResult.FailedAuthenticationModel> getFailedAuthentications()

Gets the list of failed authentication attempts

Returns:

The list of failed authentication attempts

setFailedAuthentications

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