org.alfresco.service.cmr.remoteticket

Interface RemoteAlfrescoTicketInfo

All Known Implementing Classes:

AbstractRemoteAlfrescoTicketImpl, AlfTicketRemoteAlfrescoTicketImpl, GuestRemoteAlfrescoTicketImpl

public interface RemoteAlfrescoTicketInfo

Holds details on a Ticket from a Remote Alfresco System, and provides ways to get it into different forms suitable for sending back to the Remote System. Currently, only regular Tickets are supported, but this is designed to handle things like OAuth later

Since:

4.0.2

Author:

Nick Burch

Method Summary

Modifier and Type	Method and Description
String	getAsEscapedUrlParameters() Returns the Ticket as a URL Escaped Parameter fragment, such as "ticket=12%20xx&sig=2".
String	getAsHTTPAuthorization() Returns the Ticket in the form used for HTTP Basic Authentication.
String	getAsUrlParameters() Returns the Ticket as a URL Parameter fragment, such as "ticket=123&sig=13".
org.alfresco.util.Pair<String,String>	getAsUsernameAndPassword() Returns the Ticket in the form of a pseudo username and password.

Method Detail

getAsUrlParameters

String getAsUrlParameters()

Returns the Ticket as a URL Parameter fragment, such as "ticket=123&sig=13". No escaping is done

getAsEscapedUrlParameters

String getAsEscapedUrlParameters()

Returns the Ticket as a URL Escaped Parameter fragment, such as "ticket=12%20xx&sig=2". Special characters in the URL are escaped suitable for using as full URL, but any ampersands are not escaped (it's not HTML escaped)

getAsHTTPAuthorization

String getAsHTTPAuthorization()

Returns the Ticket in the form used for HTTP Basic Authentication. This should be added as the value to a HTTP Request Header with key Authorization

getAsUsernameAndPassword

org.alfresco.util.Pair<String,String> getAsUsernameAndPassword()

Returns the Ticket in the form of a pseudo username and password. The Username is normally a special ticket identifier, and the password is the ticket in a suitably encoded form.