Package org.apereo.cas.authentication.principal

Interface WebApplicationService

All Superinterfaces:

Serializable, Service

public interface WebApplicationService
extends Service

Represents a service using CAS that comes from the web.

Since:

3.1

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BEAN_NAME_FACTORY	Bean name for the factory implementation that creates this service type.

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

LOGGER, SERVICE_ATTRIBUTE_COOKIES, SERVICE_ATTRIBUTE_HEADERS, SERVICE_ATTRIBUTE_HTTP_REQUEST

Method Summary

Modifier and Type	Method	Description
String	getArtifactId()	Retrieves the artifact supplied with the service.
org.apereo.cas.validation.ValidationResponseType	getFormat()	Ticket validation response MUST be produced based on the parameter value.
String	getFragment()	Gets fragment.
String	getSource()	Indicates the source from which the service object was extracted and built.
boolean	isLoggedOutAlready()	Return if the service is already logged out.
WebApplicationService	setFragment(String fragment)	Collect fragment in web application service.
void	setLoggedOutAlready(boolean loggedOutAlready)	Set if the service is already logged out.

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

getAttributeAs, getAttributes, getFirstAttribute, getId, getOriginalUrl, getShortenedId, setAttributes, setPrincipal

Field Details

BEAN_NAME_FACTORY

static final String BEAN_NAME_FACTORY

Bean name for the factory implementation that creates this service type.

See Also:

• Constant Field Values

Method Details

getArtifactId

String getArtifactId()

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

Returns:

the artifact if it exists, null otherwise.

getSource

String getSource()

Indicates the source from which the service object was extracted and built. Typically maps to a request parameter or attribute that provides the request.

Returns:

the source if it exists, null otherwise.

getFormat

org.apereo.cas.validation.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.

setFragment

WebApplicationService setFragment(String fragment)

Collect fragment in web application service.

Parameters:

fragment - the fragment

Returns:

the web application service

getFragment

String getFragment()

Gets fragment.

Returns:

the fragment