com.pega.pegarules.pub.context

Interface PRAuthentication

public interface PRAuthentication

The Authentication interface

Version:

$Revision: 69724 $ $Date: 2013-09-24 15:19:02 -0400 (Tue, 24 Sep 2013) $

Author:

Leonid Ablavsky

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT
static java.lang.String	DEFAULT_CHALLENGE Custom authentication return status - use Auth Service challenge settings
static java.lang.String	DEFAULT_FAIL_STREAM Custom authentication return status - use fail stream from Auth Service challenge settings
static java.lang.String	DEFAULT_REDIRECT_URL Custom authentication return status - use redirect URL from Auth Service challenge settings
static java.lang.String	GENERATED_CHALLENGE_STREAM Custom authentication return status - use challenge stream generated by authentication activity
static java.lang.String	GENERATED_REDIRECT_URL Custom authentication return status - use redirect URL from Auth Service challenge settings
static java.lang.String	VERSION

Method Summary

Methods

Modifier and Type	Method and Description
void	forceSchemeReload() Forces authentication scheme definitions to be reloaded.
void	forceTimeout() If the active authentication scheme supports PegaRULES timeout, force authentication timeout immediately so that a challenge will be issued on the next interaction.
java.lang.String	getEncryptedString(java.lang.String aClearText) Encrypts a string using PegaRULES v3 algorithm The entire string, converted to a byte array using UTF-8 encoding, is passed through the MD5 digest algorithm.
java.lang.String	getExternalSignature() Return a random, time-based value
boolean	isAuthenticated() Return true if (requestor) is authenticated (that is, not a "guest") and has not timed out or otherwise had authentication temporarily suspended.
boolean	performAuthentication(java.lang.String aUserIdentifier, java.lang.String aPassword) Perform the standard PegaRULES authentication on the supplied username and (cleartext) password pair.
void	presentAuthentication() Invoke the custom welcome for the authentication scheme in use
boolean	setAccessGroup(PublicAPI aCaller, java.lang.String aAccessGroupName) Deprecated.
boolean	setFailCount(PublicAPI aCaller, int aFailCount) Deprecated. convert callers to AuthService
boolean	setUserAuthenticated(PublicAPI aCaller, boolean aAuthenticatonFlag) Deprecated. convert callers to AuthService
boolean	setUserSecurityProfile(PublicAPI aCaller, java.lang.String aUserID) Deprecated. convert callers to AuthService
boolean	setUserSecurityProfile(PublicAPI aCaller, java.lang.String aUserID, ClipboardPage aOperPage) Deprecated. convert callers to AuthService
boolean	setUserSecurityProfile(PublicAPI aCaller, java.lang.String aUserID, ParameterPage aParamPage) Deprecated. convert callers to AuthService
boolean	setUserSecurityProfile(PublicAPI aCaller, java.lang.String aUserID, java.lang.String aAssignedUserName) Deprecated. convert callers to AuthService
void	unauthenticate() Unauthenticate this requestor, turning it into a guest.

Field Detail

VERSION

static final java.lang.String VERSION

COPYRIGHT

static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

DEFAULT_CHALLENGE

static final java.lang.String DEFAULT_CHALLENGE

Custom authentication return status - use Auth Service challenge settings

See Also:

Constant Field Values

GENERATED_CHALLENGE_STREAM

static final java.lang.String GENERATED_CHALLENGE_STREAM

Custom authentication return status - use challenge stream generated by authentication activity

See Also:

Constant Field Values

DEFAULT_FAIL_STREAM

static final java.lang.String DEFAULT_FAIL_STREAM

Custom authentication return status - use fail stream from Auth Service challenge settings

See Also:

Constant Field Values

DEFAULT_REDIRECT_URL

static final java.lang.String DEFAULT_REDIRECT_URL

Custom authentication return status - use redirect URL from Auth Service challenge settings

See Also:

Constant Field Values

GENERATED_REDIRECT_URL

static final java.lang.String GENERATED_REDIRECT_URL

Custom authentication return status - use redirect URL from Auth Service challenge settings

See Also:

Constant Field Values

Method Detail

getEncryptedString

java.lang.String getEncryptedString(java.lang.String aClearText)

Encrypts a string using PegaRULES v3 algorithm The entire string, converted to a byte array using UTF-8 encoding, is passed through the MD5 digest algorithm. The resulting 16-byte digest value is converted to a base-16 character string and returned.

Parameters:

aClearText - cleartext string

Returns:

32-character string representing MD5 digest

getExternalSignature

java.lang.String getExternalSignature()

Return a random, time-based value

Returns:

32-character string of quasi-random values

isAuthenticated

boolean isAuthenticated()

Return true if (requestor) is authenticated (that is, not a "guest") and has not timed out or otherwise had authentication temporarily suspended.

Returns:

true if user is currently considered authenticated

performAuthentication

boolean performAuthentication(java.lang.String aUserIdentifier,
                            java.lang.String aPassword)

Perform the standard PegaRULES authentication on the supplied username and (cleartext) password pair. Update the supplied user profile instance (if supplied) with information from the service.

Depending upon administrative configuration, this may be done entirely within PegaRULES, or may invoke an external service.

Parameters:

aUserIdentifier - User ID: aPassord password in clear text

aPassword -

Returns:

true if authentication succeeded

setAccessGroup

boolean setAccessGroup(PublicAPI aCaller,
                     java.lang.String aAccessGroupName)
                       throws PRSecurityException

Deprecated.

Apply specified Access Group to the security profile
As of v5.3, this method may only be used by activities associated with the active PRExternal authentication scheme of the requestor making the call.

Parameters:

aCaller - "executable" element to verify caller may make this request

aAccessGroupName - - name of the Access Group to apply

Returns:

true if successful

Throws:

PRSecurityException

setFailCount

boolean setFailCount(PublicAPI aCaller,
                   int aFailCount)
                     throws PRSecurityException

Deprecated. convert callers to AuthService

Set authentication fail count
As of v5.3, this method may only be used by activities associated with the active PRExternal authentication scheme of the requestor making the call.

Parameters:

aCaller - "executable" element to verify caller may make this request

aFailCount - - number of failed authentication attepmts

Returns:

true if successful

Throws:

PRSecurityException

setUserAuthenticated

boolean setUserAuthenticated(PublicAPI aCaller,
                           boolean aAuthenticatonFlag)
                             throws PRSecurityException

Deprecated. convert callers to AuthService

Set user authentication status
As of v5.3, this method may only be used by activities associated with the active PRExternal authentication scheme of the requestor making the call.

Parameters:

aCaller - "executable" element to verify caller may make this request

aAuthenticatonFlag - - sets/resets user authentication status

Returns:

true if successful

Throws:

PRSecurityException

setUserSecurityProfile

boolean setUserSecurityProfile(PublicAPI aCaller,
                             java.lang.String aUserID)
                               throws PRSecurityException

Deprecated. convert callers to AuthService

Use specified user ID to set security profile
As of v5.3, this method may only be used by activities associated with the active PRExternal authentication scheme of the requestor making the call.

Parameters:

aCaller - "executable" element to verify caller may make this request

aUserID - - user ID

Returns:

trueif successful

Throws:

PRSecurityException

setUserSecurityProfile

boolean setUserSecurityProfile(PublicAPI aCaller,
                             java.lang.String aUserID,
                             java.lang.String aAssignedUserName)
                               throws PRSecurityException

Deprecated. convert callers to AuthService

Use specified user ID to set security profile
As of v5.3, this method may only be used by activities associated with the active PRExternal authentication scheme of the requestor making the call.

Parameters:

aCaller - "executable" element to verify caller may make this request

aUserID - - user ID

aAssignedUserName - - User Name to assign to this session

Returns:

true if successful

Throws:

PRSecurityException

setUserSecurityProfile

boolean setUserSecurityProfile(PublicAPI aCaller,
                             java.lang.String aUserID,
                             ParameterPage aParamPage)
                               throws PRSecurityException

Deprecated. convert callers to AuthService

Use specified user ID to set security profile
As of v5.3, this method may only be used by activities associated with the active PRExternal authentication scheme of the requestor making the call.

Parameters:

aCaller - "executable" element to verify caller may make this request

aUserID - - user ID

aParamPage - - parameter page with properties of the Data-Admin-Operator-ID class to create the instance of this class if it does not exist

Returns:

true if successful

Throws:

PRSecurityException

setUserSecurityProfile

boolean setUserSecurityProfile(PublicAPI aCaller,
                             java.lang.String aUserID,
                             ClipboardPage aOperPage)
                               throws PRSecurityException

Deprecated. convert callers to AuthService

Use specified user ID to set security profile
As of v5.3, this method may only be used by activities associated with the active PRExternal authentication scheme of the requestor making the call.

Parameters:

aCaller - "executable" element to verify caller may make this request

aUserID - - user ID

aOperPage - - clipboard page with properties of page class Data-Admin-Operator-ID that will be used to create the operator if it does not exist

Returns:

true if successful

Throws:

PRSecurityException

presentAuthentication

void presentAuthentication()

Invoke the custom welcome for the authentication scheme in use

unauthenticate

void unauthenticate()

Unauthenticate this requestor, turning it into a guest.

forceTimeout

void forceTimeout()

If the active authentication scheme supports PegaRULES timeout, force authentication timeout immediately so that a challenge will be issued on the next interaction.

forceSchemeReload

void forceSchemeReload()

Forces authentication scheme definitions to be reloaded. (This method would be called, for example, after one of them has been edited.)