public interface ClientPrincipalResource
Modifier and Type | Interface and Description |
---|---|
static class |
ClientPrincipalResource.SealCallee
Enumeration encoding the callee of the SEAL method.
|
static class |
ClientPrincipalResource.SealFailure
Enumeration encoding the reasons for the SEAL failure.
|
Modifier and Type | Method and Description |
---|---|
logical |
authenticationFailed()
Indicates that the identity asserted in the unsealed client-principal object cannot be
authenticated.
|
logical |
authenticationFailed(character reason)
Indicates that the identity asserted in the unsealed client-principal object cannot be
authenticated.
|
logical |
authenticationFailed(character reason,
boolean fromSetClient)
Indicates that the identity asserted in the unsealed client-principal object cannot be
authenticated.
|
logical |
authenticationFailed(java.lang.String reason)
Indicates that the identity asserted in the unsealed client-principal object cannot be
authenticated.
|
logical |
authenticationFailed(java.lang.String reason,
boolean fromSetClient)
Indicates that the identity asserted in the unsealed client-principal object cannot be
authenticated.
|
raw |
exportPrincipal()
Export the state of this CLIENT-PRINCIPAL object to a byte representation.
|
character |
getAuditEventContext()
Get the AUDIT-EVENT-CONTEXT attribute.
|
character |
getClientTty()
Get the CLIENT-TTY attribute.
|
character |
getClientWks()
Get the CLIENT-WORKSTATION attribute.
|
character |
getDbList()
Get a comma-separated list of logical database names that is stored in the
client-principal object
|
character |
getDomainDescription()
Get the DOMAIN-DESCRIPTION attribute.
|
character |
getDomainName()
Get the DOMAIN-NAME attribute.
|
character |
getDomainType()
Get the DOMAIN-TYPE attribute.
|
datetimetz |
getLoginExpirationTimestamp()
Get the LOGIN-EXPIRATION-TIMESTAMP attribute.
|
character |
getLoginHost()
Get the LOGIN-HOST attribute.
|
character |
getLoginState()
Get the LOGIN-STATE attribute.
|
character |
getPrimaryPassphrase()
Get the PRIMARY-PASSPHRASE attribute.
|
character |
getProperty(character prop)
Get the value of the specified property, from the CLIENT-PRINCIPAL object.
|
character |
getProperty(java.lang.String prop)
Get the value of the specified property, from the CLIENT-PRINCIPAL object.
|
character |
getQualifiedUid()
Get the QUALIFIED-USER-ID attribute.
|
character |
getRoles()
Get the ROLES attribute.
|
datetimetz |
getSealTimestamp()
Get the SEAL-TIMESTAMP attribute.
|
character |
getSessionId()
Get the SESSION-ID attribute.
|
character |
getStateDetail()
Set the STATE-DETAIL attribute.
|
character |
getUserId()
Get the USER-ID attribute.
|
logical |
importPrincipal(raw data)
Import the state of this CLIENT-PRINCIPAL object from the specified byte representation.
|
logical |
initialize(character qualifiedUid)
Simplifies initialization of client-principal object attributes that are required and
commonly used
|
logical |
initialize(character qualifiedUid,
character sessionId)
Simplifies initialization of client-principal object attributes that are required and
commonly used
|
logical |
initialize(character qualifiedUid,
character sessionId,
BaseDataType expriration) |
logical |
initialize(character qualifiedUid,
character sessionId,
BaseDataType expriration,
character primaryPassphrase)
Simplifies initialization of client-principal object attributes that are required and
commonly used
|
boolean |
isSealed()
Check if this CLIENT-PRINCIPIAL has been sealed.
|
character |
listPropertyNames()
Get a list of all application-defined properties stored in the client-principal object.
|
logical |
logout()
Indicates that the user represented by the sealed client-principal object (in the LOGIN
state) has logged out of their current user login session.
|
character |
primaryPassphrase()
Get the PRIMARY-PASSPHRASE attribute value (for internal use).
|
logical |
seal(character domainAccessCode)
Seal this CLIENT-PRINCIPAL, using the given domain access code.
|
logical |
seal(java.lang.String domainAccessCode)
Seal this CLIENT-PRINCIPAL, using the given domain access code.
|
logical |
seal(java.lang.String domainAccessCode,
ClientPrincipalResource.SealCallee callee)
Seal this CLIENT-PRINCIPAL, using the given domain access code, for internal use.
|
ClientPrincipalResource.SealFailure |
sealFailure()
Get the SEAL operation failure reason.
|
void |
setAuditEventContext(character ctx)
Set the AUDIT-EVENT-CONTEXT Attribute.
|
void |
setAuditEventContext(java.lang.String ctx)
Set the AUDIT-EVENT-CONTEXT Attribute.
|
void |
setClientTty(character tty)
Set the CLIENT-TTY Attribute.
|
void |
setClientTty(java.lang.String tty)
Set the CLIENT-TTY Attribute.
|
void |
setClientWks(character wks)
Set the CLIENT-WORKSTATION Attribute.
|
void |
setClientWks(java.lang.String wks)
Set the CLIENT-WORKSTATION Attribute.
|
void |
setDomainDescription(character desc)
Set the DOMAIN-DESCRIPTION Attribute.
|
void |
setDomainDescription(java.lang.String desc)
Set the DOMAIN-DESCRIPTION Attribute.
|
void |
setDomainName(character domainName)
Set the DOMAIN-NAME Attribute.
|
void |
setDomainName(java.lang.String domainName)
Set the DOMAIN-NAME Attribute.
|
void |
setDomainType(character domainType)
Set the DOMAIN-TYPE Attribute.
|
void |
setDomainType(java.lang.String domainType)
Set the DOMAIN-TYPE Attribute.
|
void |
setLoginExpirationTimestamp(datetimetz ts)
Get the LOGIN-EXPIRATION-TIMESTAMP attribute.
|
void |
setLoginHost(character host)
Set the LOGIN-HOST Attribute.
|
void |
setLoginHost(java.lang.String host)
Set the LOGIN-HOST Attribute.
|
void |
setPrimaryPassphrase(character passphrase)
Set the PRIMARY-PASSPHRASE attribute.
|
void |
setPrimaryPassphrase(java.lang.String passphrase)
Set the PRIMARY-PASSPHRASE attribute.
|
logical |
setProperty(character prop,
character val)
Set this property in the CLIENT-PRINCIPAL object.
|
logical |
setProperty(character prop,
java.lang.String val)
Set this property in the CLIENT-PRINCIPAL object.
|
logical |
setProperty(java.lang.String prop,
character val)
Set this property in the CLIENT-PRINCIPAL object.
|
logical |
setProperty(java.lang.String prop,
java.lang.String val)
Set this property in the CLIENT-PRINCIPAL object.
|
void |
setQualifiedUid(character uid)
Set the QUALIFIED-USER-ID attribute.
|
void |
setQualifiedUid(java.lang.String uid)
Set the QUALIFIED-USER-ID attribute.
|
void |
setRoles(character roles)
Set the ROLES Attribute.
|
void |
setRoles(java.lang.String roles)
Set the ROLES Attribute.
|
void |
setSessionId(character sessionId)
Set the SESSION-ID Attribute.
|
void |
setSessionId(java.lang.String sessionId)
Set the SESSION-ID Attribute.
|
void |
setUserId(character userId)
Set the USER-ID Attribute.
|
void |
setUserId(java.lang.String userId)
Set the USER-ID Attribute.
|
logical |
validateDomainAccessCode(java.lang.String where,
java.lang.String dac,
ClientPrincipalResource.SealCallee callee)
Validate CLIENT-PRINCIPAL against domain access code.
|
logical |
validatePassword(java.lang.String where,
java.lang.String dac,
java.lang.String password,
ClientPrincipalResource.SealCallee callee)
Validate CLIENT-PRINCIPAL against domain password.
|
logical |
validateSeal()
Validates the message authentication code (MAC) generated by the SEAL( ) method to seal a
client-principal object.
|
logical |
validateSeal(character domainAccessCode)
Validates the message authentication code (MAC) generated by the SEAL( ) method to seal a
client-principal object.
|
logical |
validateSeal(java.lang.String domainAccessCode)
Validates the message authentication code (MAC) generated by the SEAL( ) method to seal a
client-principal object.
|
character getUserId()
void setUserId(character userId)
userId
- The value of the USER-ID attribute.void setUserId(java.lang.String userId)
userId
- The value of the USER-ID attribute.character getDomainType()
void setDomainType(character domainType)
domainType
- The value of the DOMAIN-TYPE attribute.void setDomainType(java.lang.String domainType)
domainType
- The value of the DOMAIN-TYPE attribute.character getDomainName()
void setDomainName(character domainName)
domainName
- The value of the DOMAIN-NAME attribute.void setDomainName(java.lang.String domainName)
domainName
- The value of the DOMAIN-NAME attribute.character getSessionId()
void setSessionId(character sessionId)
sessionId
- The value of the SESSION-ID attribute.void setSessionId(java.lang.String sessionId)
sessionId
- The value of the SESSION-ID attribute.character getDomainDescription()
void setDomainDescription(java.lang.String desc)
desc
- The value of the DOMAIN-DESCRIPTION attribute.void setDomainDescription(character desc)
desc
- The value of the DOMAIN-DESCRIPTION attribute.character getClientTty()
void setClientTty(java.lang.String tty)
tty
- The value of the CLIENT-TTY attribute.void setClientTty(character tty)
tty
- The value of the CLIENT-TTY attribute.character getClientWks()
void setClientWks(java.lang.String wks)
wks
- The value of the CLIENT-WORKSTATION attribute.void setClientWks(character wks)
wks
- The value of the CLIENT-WORKSTATION attribute.character getAuditEventContext()
void setAuditEventContext(java.lang.String ctx)
ctx
- The value of the AUDIT-EVENT-CONTEXT attribute.void setAuditEventContext(character ctx)
ctx
- The value of the AUDIT-EVENT-CONTEXT attribute.character getLoginHost()
void setLoginHost(java.lang.String host)
host
- The value of the LOGIN-HOST attribute.void setLoginHost(character host)
host
- The value of the LOGIN-HOST attribute.character getRoles()
void setRoles(java.lang.String roles)
roles
- The value of the ROLES attribute.void setRoles(character roles)
roles
- The value of the ROLES attribute.character getLoginState()
datetimetz getLoginExpirationTimestamp()
void setLoginExpirationTimestamp(datetimetz ts)
ts
- The time stamp specifying when the client-principal object will expire
client-principal object.datetimetz getSealTimestamp()
character getPrimaryPassphrase()
character primaryPassphrase()
void setPrimaryPassphrase(java.lang.String passphrase)
passphrase
- new value of the attributevoid setPrimaryPassphrase(character passphrase)
passphrase
- new value of the attributecharacter getQualifiedUid()
void setQualifiedUid(java.lang.String uid)
uid
- new value of the attributevoid setQualifiedUid(character uid)
uid
- new value of the attributecharacter getStateDetail()
character getDbList()
logical setProperty(character prop, character val)
prop
- The property's name.val
- The property's value.true
if the property could be set.logical setProperty(character prop, java.lang.String val)
prop
- The property's name.val
- The property's value.true
if the property could be set.logical setProperty(java.lang.String prop, character val)
prop
- The property's name.val
- The property's value.true
if the property could be set.logical setProperty(java.lang.String prop, java.lang.String val)
prop
- The property's name.val
- The property's value.true
if the property could be set.character listPropertyNames()
character getProperty(character prop)
prop
- The property's name.character getProperty(java.lang.String prop)
prop
- The property's name.raw exportPrincipal()
raw
instance.logical importPrincipal(raw data)
data
- The byte representation.true
id successfullogical seal(character domainAccessCode)
domainAccessCode
- The access code.true
id successfullogical seal(java.lang.String domainAccessCode, ClientPrincipalResource.SealCallee callee)
domainAccessCode
- The access code.callee
- the method callee.true
id successful.logical seal(java.lang.String domainAccessCode)
domainAccessCode
- The access code.true
id successfulboolean isSealed()
logical authenticationFailed()
true
id successfullogical authenticationFailed(character reason)
reason
- An optional character expression that specifies the reason for the authentication
failure.true
id successfullogical authenticationFailed(character reason, boolean fromSetClient)
reason
- An optional character expression that specifies the reason for the authentication
failure.fromSetClient
- flag indicating that called from SET-CLIENT.true
id successful.logical authenticationFailed(java.lang.String reason)
reason
- An optional character expression that specifies the reason for the authentication
failure.true
id successfullogical authenticationFailed(java.lang.String reason, boolean fromSetClient)
reason
- An optional character expression that specifies the reason for the authentication
failure.fromSetClient
- flag indicating that called from SET-CLIENT.true
id successful.logical validateSeal()
true
id successfullogical validateSeal(java.lang.String domainAccessCode)
domainAccessCode
- The access code.true
id successfullogical validateSeal(character domainAccessCode)
domainAccessCode
- The access code.true
id successfullogical logout()
true
id successfullogical initialize(character qualifiedUid)
qualifiedUid
- A character expression that evaluates to a fully qualified user ID (user name and
domain name delimited by the '@' character)true
on successlogical initialize(character qualifiedUid, character sessionId)
qualifiedUid
- A character expression that evaluates to a fully qualified user ID (user name and
domain name delimited by the '@' character)sessionId
- An optional character expression that evaluates to the user's application login session ID.true
on successlogical initialize(character qualifiedUid, character sessionId, BaseDataType expriration)
qualifiedUid
- A character expression that evaluates to a fully qualified user ID (user name and
domain name delimited by the '@' character)sessionId
- An optional character expression that evaluates to the user's application login
session ID.expriration
- An optional DATETIME-TZ expression that evaluates to a date and time value that
specifies the expiration of thee client-principal user credentialstrue
on successlogical initialize(character qualifiedUid, character sessionId, BaseDataType expriration, character primaryPassphrase)
qualifiedUid
- A character expression that evaluates to a fully qualified user ID (user name and
domain name delimited by the '@' character)sessionId
- An optional character expression that evaluates to the user's application login
session ID.expriration
- An optional DATETIME-TZ expression that evaluates to a date and time value that
specifies the expiration of thee client-principal user credentialsprimaryPassphrase
- An optional character expression that evaluates to the cleartext or encrypted value
of the user's account password.true
on successlogical validatePassword(java.lang.String where, java.lang.String dac, java.lang.String password, ClientPrincipalResource.SealCallee callee)
where
- subsystem namedac
- domain access codepassword
- domain passwordcallee
- where the method is called fromtrue
if successfullogical validateDomainAccessCode(java.lang.String where, java.lang.String dac, ClientPrincipalResource.SealCallee callee)
dac
- domain access codewhere
- subsystem namecallee
- where the method is called fromtrue
if successfulClientPrincipalResource.SealFailure sealFailure()