@AlfrescoPublicApi
public interface TicketComponent
Modifier and Type | Method and Description |
---|---|
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,
boolean autoCreate)
Get the current ticket
|
java.lang.String |
getNewTicket(java.lang.String userName)
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
|
boolean |
getUseSingleTicketPerUser()
Does this ticket component support a single ticket per user or one ticket for each time they login?
|
void |
invalidateTicketById(java.lang.String ticket)
Invalidate the tickets by id
|
void |
invalidateTicketByUser(java.lang.String userName)
Invalidate all user tickets
|
int |
invalidateTickets(boolean expiredOnly)
Invalidate tickets
|
java.lang.String |
validateTicket(java.lang.String ticket)
Check that a certificate is valid and can be used in place of a login.
|
java.lang.String getNewTicket(java.lang.String userName) throws AuthenticationException
userName
- AuthenticationException
java.lang.String getCurrentTicket(java.lang.String userName, boolean autoCreate)
userName
- autoCreate
- should we create one automatically if there isn't one?@Auditable(parameters="ticket", recordable=false) java.lang.String validateTicket(java.lang.String ticket) throws AuthenticationException
ticket
- AuthenticationException
@Auditable(parameters="ticket", recordable=false) void invalidateTicketById(java.lang.String ticket)
ticket
- void invalidateTicketByUser(java.lang.String userName)
userName
- int countTickets(boolean nonExpiredOnly)
nonExpiredOnly
- true for non expired tickets, false for all (including expired) ticketsjava.util.Set getUsersWithTickets(boolean nonExpiredOnly)
nonExpiredOnly
- true for non expired tickets, false for all (including expired) ticketsint invalidateTickets(boolean expiredOnly)
expiredOnly
- true for EXPIRED tickets, false for ALL (including non-expired) ticketsjava.lang.String getAuthorityForTicket(java.lang.String ticket)
ticket
- void clearCurrentTicket()
boolean getUseSingleTicketPerUser()
Copyright © 2005 - 2013 Alfresco Software, Inc. All Rights Reserved.