net.shibboleth.idp.saml.xmlobject

Interface Scope

All Superinterfaces:

XMLObject, XSString

public interface Scope
extends XSString

XMLObject for the Shibboleth Scope metadata extension.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ELEMENT_LOCAL_NAME Element local name.
static QName	DEFAULT_ELEMENT_NAME Default element name.
static String	REGEXP_ATTRIB_NAME regexp attribute name.

Fields inherited from interface org.opensaml.core.xml.schema.XSString

TYPE_LOCAL_NAME, TYPE_NAME

Method Summary

Methods

Modifier and Type	Method and Description
Pattern	getMatchPattern() Deprecated. No replacement. The caller should instead evaluate the scope value supplied by XSString.getValue() in an implementation-specific manner
Boolean	getRegexp() Get the regexp attribute value.
XSBooleanValue	getRegexpXSBoolean() Get the regexp attribute value.
void	setRegexp(Boolean newRegexp) Set the regexp attribute value.
void	setRegexp(XSBooleanValue newRegexp) Set the regexp attribute value.

Methods inherited from interface org.opensaml.core.xml.schema.XSString

getValue, setValue

Methods inherited from interface org.opensaml.core.xml.XMLObject

detach, getDOM, getElementQName, getIDIndex, getNamespaceManager, getNamespaces, getNoNamespaceSchemaLocation, getObjectMetadata, getOrderedChildren, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, isNil, isNilXSBoolean, releaseChildrenDOM, releaseDOM, releaseParentDOM, resolveID, resolveIDFromRoot, setDOM, setNil, setNil, setNoNamespaceSchemaLocation, setParent, setSchemaLocation

Field Detail

DEFAULT_ELEMENT_LOCAL_NAME

static final String DEFAULT_ELEMENT_LOCAL_NAME

Element local name.

See Also:

Constant Field Values

DEFAULT_ELEMENT_NAME

static final QName DEFAULT_ELEMENT_NAME

Default element name.

REGEXP_ATTRIB_NAME

static final String REGEXP_ATTRIB_NAME

regexp attribute name.

See Also:

Constant Field Values

Method Detail

getRegexp

Boolean getRegexp()

Get the regexp attribute value.

Returns:

the regexp attribute value

getRegexpXSBoolean

XSBooleanValue getRegexpXSBoolean()

Get the regexp attribute value.

Returns:

the regexp attribute value

setRegexp

void setRegexp(Boolean newRegexp)

Set the regexp attribute value.

Parameters:

newRegexp - the new regexp attribute value

setRegexp

void setRegexp(XSBooleanValue newRegexp)

Set the regexp attribute value.

Parameters:

newRegexp - the new regexp attribute value

getMatchPattern

@Deprecated
Pattern getMatchPattern()

Deprecated. No replacement. The caller should instead evaluate the scope value supplied by XSString.getValue() in an implementation-specific manner

Convenience method which returns a match Pattern that may be used to evaluate whether a candidate scope matches the scope criteria given by this extension, when the value is indicated to be a regular expression.

This may only be called when getRegexp() evaluates to true. Otherwise an IllegalStateException is thrown.

The scope value supplied to XSString.setValue(String) MUST be a valid Java regular expression as defined by Pattern, else a fatal error will result.

Returns:

match pattern used to evaluate if a scope matches a regular expression scope criteria