org.jboss.shrinkwrap.descriptor.api.webcommon30
Interface SecurityConstraintType<T>

All Superinterfaces:
org.jboss.shrinkwrap.descriptor.api.Child<T>
All Known Implementing Classes:
SecurityConstraintTypeImpl

public interface SecurityConstraintType<T>
extends org.jboss.shrinkwrap.descriptor.api.Child<T>

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

Original Documentation:



The security-constraintType is used to associate
security constraints with one or more web resource
collections

Used in: web-app


Since:
Generation date :2011-07-19T22:55:02.759+02:00
Author:
Ralf Battenfeld

Method Summary
 AuthConstraintType<SecurityConstraintType<T>> authConstraint()
          If not already created, a new auth-constraint element will be created and returned.
 java.util.List<java.lang.String> getDisplayNameList()
          Returns all display-name elements
 java.util.List<WebResourceCollectionType<SecurityConstraintType<T>>> getWebResourceCollectionList()
          Returns all web-resource-collection elements
 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> removeUserDataConstraint()
          Removes the user-data-constraint element
 SecurityConstraintType<T> setDisplayName(java.lang.String displayName)
          Creates a new display-name element
 SecurityConstraintType<T> setDisplayNameList(java.lang.String... values)
          Creates for all String objects representing display-name elements, a new display-name element
 UserDataConstraintType<SecurityConstraintType<T>> userDataConstraint()
          If not already created, a new user-data-constraint element will be created and returned.
 WebResourceCollectionType<SecurityConstraintType<T>> webResourceCollection()
          Returns the web-resource-collection element
 
Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Child
up
 

Method Detail

setDisplayName

SecurityConstraintType<T> setDisplayName(java.lang.String displayName)
Creates a new display-name element

Returns:
the current instance of SecurityConstraintType

setDisplayNameList

SecurityConstraintType<T> setDisplayNameList(java.lang.String... values)
Creates for all String objects representing display-name elements, a new display-name element

Parameters:
list - of display-name objects
Returns:
the current instance of SecurityConstraintType

removeAllDisplayName

SecurityConstraintType<T> removeAllDisplayName()
Removes the display-name element

Returns:
the current instance of SecurityConstraintType

getDisplayNameList

java.util.List<java.lang.String> getDisplayNameList()
Returns all display-name elements

Returns:
list of display-name

removeAllWebResourceCollection

SecurityConstraintType<T> removeAllWebResourceCollection()
Removes all web-resource-collection elements

Returns:
the current instance of SecurityConstraintType

webResourceCollection

WebResourceCollectionType<SecurityConstraintType<T>> webResourceCollection()
Returns the web-resource-collection element

Returns:
the node defined for the element web-resource-collection

getWebResourceCollectionList

java.util.List<WebResourceCollectionType<SecurityConstraintType<T>>> getWebResourceCollectionList()
Returns all web-resource-collection elements

Returns:
list of web-resource-collection

removeAuthConstraint

SecurityConstraintType<T> removeAuthConstraint()
Removes the auth-constraint element

Returns:
the current instance of SecurityConstraintType

authConstraint

AuthConstraintType<SecurityConstraintType<T>> authConstraint()
If not already created, a new auth-constraint element will be created and returned. Otherwise, the existing auth-constraint element will be returned.

Returns:
the node defined for the element auth-constraint

removeUserDataConstraint

SecurityConstraintType<T> removeUserDataConstraint()
Removes the user-data-constraint element

Returns:
the current instance of SecurityConstraintType

userDataConstraint

UserDataConstraintType<SecurityConstraintType<T>> userDataConstraint()
If not already created, a new user-data-constraint element will be created and returned. Otherwise, the existing user-data-constraint element will be returned.

Returns:
the node defined for the element user-data-constraint