org.jasig.cas.services
Class RegisteredService

java.lang.Object
  org.jasig.cas.services.RegisteredService

public final class RegisteredService

extends java.lang.Object

Class representing a service we have registered with the system. RegisteredServices are assumed to be "approved" services and thus have special options, such as allowing proxying, forcing renew=true, and the ability to skin the login.

Since:

3.0

Version:

$Revision$ $Date$

Author:

Scott Battaglia

Constructor Summary

RegisteredService(java.lang.String id, boolean allowedToProxy, boolean forceAuthentication, java.lang.String theme, java.net.URL proxyUrl)
Constructs a new RegisteredService with the required property of id and the optional theme and proxyUrl.

Method Summary

java.lang.String	getId()
java.net.URL	getProxyUrl() Method to retrieve the Proxy URL.
java.lang.String	getTheme()
boolean	isAllowedToProxy()
boolean	isForceAuthentication()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RegisteredService

public RegisteredService(java.lang.String id,
                         boolean allowedToProxy,
                         boolean forceAuthentication,
                         java.lang.String theme,
                         java.net.URL proxyUrl)

Constructs a new RegisteredService with the required property of id and the optional theme and proxyUrl.

Parameters:

id - The identifier for the service.

allowedToProxy - Is this service allowed to proxy

forceAuthentication - does it opt out of single sign on

theme - the theme associated with the service

proxyUrl - the proxyUrl of the service if applicable.

Throws:

java.lang.IllegalArgumentException - if the ID is null.

Method Detail

isAllowedToProxy

public boolean isAllowedToProxy()

Returns:

Returns the allowedToProxy.

isForceAuthentication

public boolean isForceAuthentication()

Returns:

Returns the forceAuthentication.

getId

public java.lang.String getId()

Returns:

Returns the id.

getTheme

public java.lang.String getTheme()

Returns:

Returns the theme.

getProxyUrl

public java.net.URL getProxyUrl()

Method to retrieve the Proxy URL.

Returns:

the Proxy URL or null if there is none.