|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@PublicService public interface AuthenticationService
The authentication service defines the API for managing authentication information against a user id.
Method Summary | |
---|---|
void |
authenticate(java.lang.String userName,
char[] password)
Carry out an authentication attempt. |
void |
authenticateAsGuest()
Authenticate as the guest user. |
boolean |
authenticationExists(java.lang.String userName)
Check if the given authentication exists. |
void |
clearCurrentSecurityContext()
Remove the current security information |
boolean |
getAuthenticationEnabled(java.lang.String userName)
Is an authentication enabled or disabled? |
java.lang.String |
getCurrentTicket()
Gets the current ticket as a string. |
java.lang.String |
getCurrentTicket(java.lang.String sessionId)
Gets the current ticket as a string. |
java.lang.String |
getCurrentUserName()
Get the name of the currently authenticated user. |
java.util.Set |
getDefaultAdministratorUserNames()
Gets a set of user names who should be considered 'administrators' by default. |
java.util.Set |
getDefaultGuestUserNames()
Gets a set of user names who should be considered 'guests' by default. |
java.util.Set |
getDomains()
Get the domain to which this instance of an authentication service applies. |
java.util.Set |
getDomainsThatAllowUserCreation()
Does this instance alow user to be created? |
java.util.Set |
getDomainsThatAllowUserDeletion()
Does this instance allow users to be deleted? |
java.util.Set |
getDomiansThatAllowUserPasswordChanges()
Does this instance allow users to update their passwords? |
java.lang.String |
getNewTicket(java.lang.String sessionId)
Get a new ticket as a string |
boolean |
guestUserAuthenticationAllowed()
Check if Guest user authentication is allowed. |
void |
invalidateTicket(java.lang.String ticket,
java.lang.String sessionId)
Invalidate a single ticket by ID or remove its association with a given session ID. |
void |
invalidateUserSession(java.lang.String userName)
Invalidate any tickets held by the user. |
boolean |
isCurrentUserTheSystemUser()
Is the current user the system user? |
void |
validate(java.lang.String ticket,
java.lang.String sessionId)
Validate a ticket and associate it with a given app server session ID. |
Method Detail |
---|
@Auditable(parameters="userName") boolean getAuthenticationEnabled(java.lang.String userName) throws AuthenticationException
userName
-
AuthenticationException
@Auditable(parameters={"userName", "password"}, recordable={true, false}) void authenticate(java.lang.String userName, char[] password) throws AuthenticationException
userName
- the usernamepassword
- the passowrd
AuthenticationException
@Auditable void authenticateAsGuest() throws AuthenticationException
AuthenticationException
@Auditable boolean guestUserAuthenticationAllowed()
@Auditable(parameters="userName") boolean authenticationExists(java.lang.String userName)
userName
- the username
@Auditable java.lang.String getCurrentUserName() throws AuthenticationException
AuthenticationException
@Auditable(parameters="userName") void invalidateUserSession(java.lang.String userName) throws AuthenticationException
userName
-
AuthenticationException
@Auditable(parameters={"ticket", "sessionId"}, recordable={false, false}) void invalidateTicket(java.lang.String ticket, java.lang.String sessionId) throws AuthenticationException
ticket
- sessionId
- the app server session ID (e.g. HttpSession ID) or null
if not applicable.
AuthenticationException
@Auditable(parameters={"ticket", "sessionId"}, recordable={false, false}) void validate(java.lang.String ticket, java.lang.String sessionId) throws AuthenticationException
ticket
- sessionId
- the app server session ID (e.g. HttpSession ID) or null
if not applicable.
AuthenticationException
@Auditable(parameters="sessionId", recordable=false) java.lang.String getCurrentTicket(java.lang.String sessionId)
sessionId
- the app server session ID (e.g. HttpSession ID) or null
if not applicable. If non-null,
the ticket returned is either a new one or one previously associated with the same sessionId by
AuthenticationService.validate(String, String)
or AuthenticationService.getCurrentTicket(String)
.
@Auditable java.lang.String getCurrentTicket()
@Auditable(parameters="sessionId", recordable=false) java.lang.String getNewTicket(java.lang.String sessionId)
sessionId
- the app server session ID (e.g. HttpSession ID) or null
if not applicable.
@Auditable void clearCurrentSecurityContext()
@Auditable boolean isCurrentUserTheSystemUser()
@Auditable java.util.Set getDomains()
@Auditable java.util.Set getDomainsThatAllowUserCreation()
@Auditable java.util.Set getDomainsThatAllowUserDeletion()
@Auditable java.util.Set getDomiansThatAllowUserPasswordChanges()
@Auditable java.util.Set getDefaultAdministratorUserNames()
@Auditable java.util.Set getDefaultGuestUserNames()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |