cas.config
Class JCasSchemeTag

java.lang.Object
  cas.xml.AbstractCasSaxTagHandler
      cas.config.JCasSchemeTag

All Implemented Interfaces:

CasSaxTagHandler

public class JCasSchemeTag

extends AbstractCasSaxTagHandler

Configuration object for a scheme.

Version:

1.0

Author:

Ralph Schuster

Field Summary

protected List	allowFrom the allowFrom definitions
protected JCasCookiesTag	cookie the cookies definition
protected JCasCustomAuthorizationTag	customAuth the CUSTOM auth definition
protected JCasExtendedAuthorizationTag	extendedAuth the extended auth definition
protected String	instance The instance
protected String	jaasName the JAAS definition
protected String	logfile The logfile
protected File	logFile The log file
protected static String	NAME The tag name
protected static String[]	parents The parents
protected String	schemeName The scheme name
protected JCasSystemAuthorizationTag	systemAuth the SYSTEM auth definition
protected Boolean	useCookies Use cookies

Constructor Summary

JCasSchemeTag()
Creates a new instance of JCasSchemeTag

Method Summary

protected AbstractCasSaxTagHandler	createHandler(String tagName, Attributes attributes) Returns a new instance of the handler for the specified sub tag.
List	getAllowFrom() Returns the allow from configs.
JCasCookiesTag	getCookies() Returns the cookie handler.
String	getCustomAuthorizationQuery(String user) Returns the query used for custom authorization.
JCasFunctionTag[]	getFunctions() Returns the functions from the extended authorization.
String	getInstance() Returns the instance.
String	getJaas() Returns the JAAS config name.
File	getLogfile() Returns the logfile.
String[]	getParentTagNames() Returns the tag names of all possible parents.
JCasQueryTag[]	getQueries() Returns the queries from the extended authorization.
Set	getRequiredRoles() Returns the roles required from system authorization.
String	getSchemeName() Returns the name of the scheme.
protected String[]	getSubTagNames() Returns the tag names that can appear within this handler but actually do not contain other tags.
String	getTagName() Returns the tag name this handler will take care of.
boolean	getUseCookies() Returns the UseCookies parameter.
boolean	isCustomAuthorization() Returns true if custom authorization is enabled.
boolean	isDatabase() Returns true if database authentication should be performed.
boolean	isExtendedAuthorization() Returns true if extended authorization is enabled.
boolean	isJaas() Returns true if JAAS should be performed.
boolean	isSystemAuthorization() Returns true if system authorization is enabled.
void	tagCompleted() Validates the configuration.

Methods inherited from class cas.xml.AbstractCasSaxTagHandler

characters, clear, endElement, getHandler, getSubHandler, getSubHandlerCount, getSubHandlers, getSubTag, getSubTag, getSubTagCount, getSubTags, ignoresUnknownTags, setAttributes, setIgnoreUnknownTags, startElement

Methods inherited from class java.lang.Object

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

Field Detail

NAME

protected static String NAME

The tag name

parents

protected static String[] parents

The parents

schemeName

protected String schemeName

The scheme name

instance

protected String instance

The instance

logfile

protected String logfile

The logfile

logFile

protected File logFile

The log file

cookie

protected JCasCookiesTag cookie

the cookies definition

systemAuth

protected JCasSystemAuthorizationTag systemAuth

the SYSTEM auth definition

customAuth

protected JCasCustomAuthorizationTag customAuth

the CUSTOM auth definition

extendedAuth

protected JCasExtendedAuthorizationTag extendedAuth

the extended auth definition

jaasName

protected String jaasName

the JAAS definition

allowFrom

protected List allowFrom

the allowFrom definitions

useCookies

protected Boolean useCookies

Use cookies

Constructor Detail

JCasSchemeTag

public JCasSchemeTag()

Creates a new instance of JCasSchemeTag

Method Detail

createHandler

protected AbstractCasSaxTagHandler createHandler(String tagName,
                                                 Attributes attributes)

Description copied from class: AbstractCasSaxTagHandler

Returns a new instance of the handler for the specified sub tag.

Specified by:

createHandler in class AbstractCasSaxTagHandler

Parameters:

tagName - - name of the sub tag

Returns:

new instance of sub tag handler or null

getParentTagNames

public String[] getParentTagNames()

Description copied from class: AbstractCasSaxTagHandler

Returns the tag names of all possible parents.

Specified by:

getParentTagNames in class AbstractCasSaxTagHandler

Returns:

- the tag names of possible parents

getSubTagNames

protected String[] getSubTagNames()

Description copied from class: AbstractCasSaxTagHandler

Returns the tag names that can appear within this handler but actually do not contain other tags.

Overrides:

getSubTagNames in class AbstractCasSaxTagHandler

Returns:

- all tag names that represent simple tags.

getTagName

public String getTagName()

Description copied from interface: CasSaxTagHandler

Returns the tag name this handler will take care of.

Returns:

- a tag name.

tagCompleted

public void tagCompleted()
                  throws SAXException

Description copied from class: AbstractCasSaxTagHandler

Validates the configuration. By default this method does nothing but handlers should override to check the values.

Specified by:

tagCompleted in interface CasSaxTagHandler

Overrides:

tagCompleted in class AbstractCasSaxTagHandler

Throws:

SAXException

getSchemeName

public String getSchemeName()

Returns the name of the scheme.

getInstance

public String getInstance()

Returns the instance.

getLogfile

public File getLogfile()

Returns the logfile.

getUseCookies

public boolean getUseCookies()

Returns the UseCookies parameter.

getAllowFrom

public List getAllowFrom()

Returns the allow from configs.

isSystemAuthorization

public boolean isSystemAuthorization()

Returns true if system authorization is enabled.

isCustomAuthorization

public boolean isCustomAuthorization()

Returns true if custom authorization is enabled.

isExtendedAuthorization

public boolean isExtendedAuthorization()

Returns true if extended authorization is enabled.

getRequiredRoles

public Set getRequiredRoles()

Returns the roles required from system authorization.

getCustomAuthorizationQuery

public String getCustomAuthorizationQuery(String user)

Returns the query used for custom authorization.

getFunctions

public JCasFunctionTag[] getFunctions()

Returns the functions from the extended authorization.

getQueries

public JCasQueryTag[] getQueries()

Returns the queries from the extended authorization.

getCookies

public JCasCookiesTag getCookies()

Returns the cookie handler.

getJaas

public String getJaas()

Returns the JAAS config name.

isJaas

public boolean isJaas()

Returns true if JAAS should be performed.

isDatabase

public boolean isDatabase()

Returns true if database authentication should be performed.