|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface TicketComponent
Manage authentication tickets
Method Summary | |
---|---|
void |
clearCurrentTicket()
Clear the current ticket |
int |
countTickets(boolean nonExpiredOnly)
Count tickets This may be higher than the user count, since a user can have more than one ticket/session |
java.lang.String |
getAuthorityForTicket(java.lang.String ticket)
Get the authority for the given ticket |
java.lang.String |
getCurrentTicket(java.lang.String userName,
java.lang.String sessionId,
boolean autoCreate)
Gets the current ticket. |
java.lang.String |
getNewTicket(java.lang.String userName,
java.lang.String sessionId)
Register a new ticket. |
java.util.Set |
getUsersWithTickets(boolean nonExpiredOnly)
Get set of users with tickets This may be lower than the ticket count, since a user can have more than one ticket/session |
void |
invalidateTicketById(java.lang.String ticket,
java.lang.String sessionId)
Invalidates a ticket, or disassociates it from an app server session. |
void |
invalidateTicketByUser(java.lang.String userName)
Invalidate all user tickets |
int |
invalidateTickets(boolean expiredOnly)
Invalidate tickets |
java.lang.String |
validateTicket(java.lang.String ticket,
java.lang.String sessionId)
Check that a certificate is valid and can be used in place of a login. |
Method Detail |
---|
java.lang.String getNewTicket(java.lang.String userName, java.lang.String sessionId) throws AuthenticationException
userName
- sessionId
- the app server session ID (e.g. HttpSession ID) or null
if not applicable.
AuthenticationException
java.lang.String getCurrentTicket(java.lang.String userName, java.lang.String sessionId, boolean autoCreate)
userName
- sessionId
- the app server session ID (e.g. HttpSession ID) or null
if not applicable.autoCreate
- should we create one automatically if there isn't one?
java.lang.String validateTicket(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
void invalidateTicketById(java.lang.String ticket, java.lang.String sessionId)
ticket
- sessionId
- the app server session ID (e.g. HttpSession ID) or null
if the ticket should be
invalidated globally.void invalidateTicketByUser(java.lang.String userName)
userName
- int countTickets(boolean nonExpiredOnly)
nonExpiredOnly
- true for non expired tickets, false for all (including expired) tickets
java.util.Set getUsersWithTickets(boolean nonExpiredOnly)
nonExpiredOnly
- true for non expired tickets, false for all (including expired) tickets
int invalidateTickets(boolean expiredOnly)
expiredOnly
- true for EXPIRED tickets, false for ALL (including non-expired) tickets
java.lang.String getAuthorityForTicket(java.lang.String ticket)
ticket
-
void clearCurrentTicket()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |