org.apereo.cas.authentication.principal

Interface WebApplicationService

All Superinterfaces:

Principal, java.io.Serializable, Service

All Known Implementing Classes:

AbstractWebApplicationService, GoogleAccountsService, OpenIdService, SamlService, SimpleWebApplicationServiceImpl, TokenWebApplicationServiceResponseBuilder.TokenWebApplicationService

public interface WebApplicationService
extends Service

Represents a service using CAS that comes from the web.

Since:

3.1

Method Summary

Modifier and Type	Method and Description
java.lang.String	getArtifactId() Retrieves the artifact supplied with the service.
ValidationResponseType	getFormat() Ticket validation response MUST be produced based on the parameter value.
java.lang.String	getOriginalUrl() Return the original url provided (as service or targetService request parameter).
boolean	isLoggedOutAlready() Return if the service is already logged out.
void	setLoggedOutAlready(boolean loggedOutAlready) Set if the service is already logged out.

Methods inherited from interface org.apereo.cas.authentication.principal.Service

matches, setPrincipal

Methods inherited from interface org.apereo.cas.authentication.principal.Principal

getAttributes, getId

Method Detail

getArtifactId

java.lang.String getArtifactId()

Retrieves the artifact supplied with the service. May be null.

Returns:

the artifact if it exists, null otherwise.

getOriginalUrl

java.lang.String getOriginalUrl()

Return the original url provided (as service or targetService request parameter). Used to reconstruct the redirect url.

Returns:

the original url provided.

getFormat

ValidationResponseType getFormat()

Ticket validation response MUST be produced based on the parameter value. Supported values are XML and JSON. If this parameter is not set, the default XML format will be used. If the parameter value is not supported by the CAS server, an error must be produced.

Returns:

the requested format

Since:

4.2

isLoggedOutAlready

boolean isLoggedOutAlready()

Return if the service is already logged out.

Returns:

if the service is already logged out.

setLoggedOutAlready

void setLoggedOutAlready(boolean loggedOutAlready)

Set if the service is already logged out.

Parameters:

loggedOutAlready - if the service is already logged out.