org.jboss.shrinkwrap.descriptor.api.webapp25

Interface SecurityConstraintType<T>

All Superinterfaces:

Child<T>, JavaeeSecurityConstraintCommonType<T,SecurityConstraintType<T>,WebResourceCollectionType<SecurityConstraintType<T>>,AuthConstraintType<SecurityConstraintType<T>>,UserDataConstraintType<SecurityConstraintType<T>>>

public interface SecurityConstraintType<T>
extends Child<T>, JavaeeSecurityConstraintCommonType<T,SecurityConstraintType<T>,WebResourceCollectionType<SecurityConstraintType<T>>,AuthConstraintType<SecurityConstraintType<T>>,UserDataConstraintType<SecurityConstraintType<T>>>

This interface defines the contract for the security-constraintType xsd type

Author:

Ralf Battenfeld, Andrew Lee Rubinger, George Gastaldi

Method Summary

Modifier and Type	Method and Description
WebResourceCollectionType<SecurityConstraintType<T>>	createWebResourceCollection() Creates a new web-resource-collection element
SecurityConstraintType<T>	displayName(String... values) Creates for all String objects representing display-name elements, a new display-name element
List<String>	getAllDisplayName() Returns all display-name elements
List<WebResourceCollectionType<SecurityConstraintType<T>>>	getAllWebResourceCollection() Returns all web-resource-collection elements
String	getId() Returns the id attribute
AuthConstraintType<SecurityConstraintType<T>>	getOrCreateAuthConstraint() If not already created, a new auth-constraint element with the given value will be created.
UserDataConstraintType<SecurityConstraintType<T>>	getOrCreateUserDataConstraint() If not already created, a new user-data-constraint element with the given value will be created.
WebResourceCollectionType<SecurityConstraintType<T>>	getOrCreateWebResourceCollection() If not already created, a new web-resource-collection element will be created and returned.
SecurityConstraintType<T>	id(String id) Sets the id attribute
SecurityConstraintType<T>	removeAllDisplayName() Removes the display-name element
SecurityConstraintType<T>	removeAllWebResourceCollection() Removes all web-resource-collection elements
SecurityConstraintType<T>	removeAuthConstraint() Removes the auth-constraint element
SecurityConstraintType<T>	removeId() Removes the id attribute
SecurityConstraintType<T>	removeUserDataConstraint() Removes the user-data-constraint element

Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Child

up

Method Detail

displayName

SecurityConstraintType<T> displayName(String... values)

Creates for all String objects representing display-name elements, a new display-name element

Parameters:

values - list of display-name objects

Returns:

the current instance of SecurityConstraintType

getAllDisplayName

List<String> getAllDisplayName()

Returns all display-name elements

Returns:

list of display-name

removeAllDisplayName

SecurityConstraintType<T> removeAllDisplayName()

Removes the display-name element

Returns:

the current instance of SecurityConstraintType

getOrCreateWebResourceCollection

WebResourceCollectionType<SecurityConstraintType<T>> getOrCreateWebResourceCollection()

If not already created, a new web-resource-collection element will be created and returned. Otherwise, the first existing web-resource-collection element will be returned.

Returns:

the instance defined for the element web-resource-collection

createWebResourceCollection

WebResourceCollectionType<SecurityConstraintType<T>> createWebResourceCollection()

Creates a new web-resource-collection element

Returns:

the new created instance of WebResourceCollectionType>

getAllWebResourceCollection

List<WebResourceCollectionType<SecurityConstraintType<T>>> getAllWebResourceCollection()

Returns all web-resource-collection elements

Returns:

list of web-resource-collection

removeAllWebResourceCollection

SecurityConstraintType<T> removeAllWebResourceCollection()

Removes all web-resource-collection elements

Returns:

the current instance of WebResourceCollectionType>

getOrCreateAuthConstraint

AuthConstraintType<SecurityConstraintType<T>> getOrCreateAuthConstraint()

If not already created, a new auth-constraint element with the given value will be created. Otherwise, the existing auth-constraint element will be returned.

Returns:

a new or existing instance of AuthConstraintType>

removeAuthConstraint

SecurityConstraintType<T> removeAuthConstraint()

Removes the auth-constraint element

Returns:

the current instance of SecurityConstraintType

getOrCreateUserDataConstraint

UserDataConstraintType<SecurityConstraintType<T>> getOrCreateUserDataConstraint()

If not already created, a new user-data-constraint element with the given value will be created. Otherwise, the existing user-data-constraint element will be returned.

Returns:

a new or existing instance of UserDataConstraintType>

removeUserDataConstraint

SecurityConstraintType<T> removeUserDataConstraint()

Removes the user-data-constraint element

Returns:

the current instance of SecurityConstraintType

id

SecurityConstraintType<T> id(String id)

Sets the id attribute

Parameters:

id - the value for the attribute id

Returns:

the current instance of SecurityConstraintType

getId

String getId()

Returns the id attribute

Returns:

the value defined for the attribute id

removeId

SecurityConstraintType<T> removeId()

Removes the id attribute

Returns:

the current instance of SecurityConstraintType