@Exported public class SSOSession extends Object
Modifier and Type | Method and Description |
---|---|
SSOAssertion |
getAssertion()
If the current application is protected by SSO filter,
this method will return the assertion object describing
the current logged in user.
|
String |
getMultiTicket()
If the current application is protected by SSO filter,
use this method to get a ticket, which could be used
to perform REST calls from Java code.
|
String |
getMultiTicket(com.fatwire.wem.sso.SSOUsernamePassword credential)
Use this method when the current application is not protected
by SSO filter and the authenticated REST call should be performed.
|
String |
getMultiTicket(String username,
String password)
Deprecated.
use getMultiTicket with SSOUsernamePassword instead. Password is passed as char[]
|
com.fatwire.wem.sso.SSOValidator |
getMultiticketValidator()
Get the interface address for the multi-ticket validator.
|
String |
getProviderType()
If the current application is protected by SSO filter,
this method will return the identifier for the provider so
client code can recognize and implement provider code variations.
|
com.fatwire.wem.sso.SSOValidator |
getProxyTicketValidator(javax.servlet.http.HttpServletRequest request,
Object pgt) |
String |
getSignoutUrl()
Returns URL, which could be used to perform
Single Sign Out.
|
String |
getSignoutUrl(String callbackUrl)
Returns URL, which could be used to perform
Single Sign Out.
|
String |
getTicket(String service)
If the current application is protected by SSO filter,
use this method to generate a ticket, which could be used
to perform REST calls from Java code.
|
String |
getTicket(String service,
com.fatwire.wem.sso.SSOUsernamePassword credential)
Use this method when the current application is not protected
by SSO filter and the authenticated REST call should be performed.
|
String |
getTicket(String service,
String username,
String password)
Deprecated.
use getTicket with SSOUsernamePassword instead
|
com.fatwire.wem.sso.SSOValidator |
getTicketValidator()
Get the interface address for the ticket validator.
|
void |
invalidate(String ticket,
String service)
Given a validator interface address, invalidate the ticket for the related service.
|
boolean |
isProxyTickets()
Determines whether proxying feature is turned on or off.
|
boolean |
isUseMultiTickets()
Determines whether support for multi tickets is enabled.
|
SSOAssertion |
validate(com.fatwire.wem.sso.SSOValidator validator,
String ticket,
String service)
Given a validator interface address, validate the ticket for the related service.
|
public SSOAssertion getAssertion() throws SSOException
SSOException
- if processing error occurs.public String getProviderType()
public String getTicket(String service) throws SSOException
SSOException
is thrown. In such a case
SSOSession.getMultiTicket()
method should be used instead.
The resulting ticket must be acquired per each REST resource URL
and could only be used once.
It's up to an application developer to decide to use either 'ticket' or 'multiticket' parameter,
when calling REST resource URL.service
- REST resource URL for which to generate a ticket.SSOException
- if any error occurs during the ticket generation phase.public String getMultiTicket() throws SSOException
SSOException
- if any error occurs during the ticket generation phase.public String getTicket(String service, String username, String password) throws SSOException
service
- REST resource URL for which to generate a ticket.username
- user name.password
- password.SSOException
- if any error occurs during the ticket generation phase.public String getTicket(String service, com.fatwire.wem.sso.SSOUsernamePassword credential) throws SSOException
service
- REST resource URL for which to generate a ticket.username
- user name.credential
- credential.SSOException
- if any error occurs during the ticket generation phase.public String getMultiTicket(String username, String password) throws SSOException
username
- user name.password
- password.SSOException
- if any error occurs during the ticket generation phase.public String getMultiTicket(com.fatwire.wem.sso.SSOUsernamePassword credential) throws SSOException
username
- user name.password
- password.SSOException
- if any error occurs during the ticket generation phase.public String getSignoutUrl() throws SSOException
SSOException
- if any error occurs during the ticket generation phase.public String getSignoutUrl(String callbackUrl) throws SSOException
callbackUrl
- URL where to redirect to upon sign out completion.SSOException
- if any error occurs during the ticket generation phase.public boolean isUseMultiTickets() throws SSOException
SSOException
- if any error occurs during the ticket generation phase.public boolean isProxyTickets() throws SSOException
SSOException
- if any error occurs during the ticket generation phase.public com.fatwire.wem.sso.SSOValidator getProxyTicketValidator(javax.servlet.http.HttpServletRequest request, Object pgt) throws SSOException
request
- http requestpgt
- ticketSSOException
- if any error occurs during the ticket generation phase.public com.fatwire.wem.sso.SSOValidator getTicketValidator() throws SSOException
SSOException
- if any error occurs during the ticket generation phase.public com.fatwire.wem.sso.SSOValidator getMultiticketValidator() throws SSOException
SSOException
- exceptionpublic SSOAssertion validate(com.fatwire.wem.sso.SSOValidator validator, String ticket, String service) throws SSOException
validator
- validate the ticket for the related serviceservice
- REST resource URL for which to generate a ticket.ticket
- string.SSOException
- if ticket is invalidpublic void invalidate(String ticket, String service) throws SSOException
service
- REST resource URL for which to generate a ticket.ticket
- string.SSOException
- if ticket is invalid