org.jboss.shrinkwrap.descriptor.api.jbossweb60

Interface ServletSecurityType<T>

All Superinterfaces:

Child<T>

public interface ServletSecurityType<T>
extends Child<T>

This interface defines the contract for the servlet-securityType xsd type

Author:

Ralf Battenfeld, Andrew Lee Rubinger

Method Summary

Modifier and Type	Method and Description
HttpMethodConstraintType<ServletSecurityType<T>>	createHttpMethodConstraint() Creates a new http-method-constraint element
ServletSecurityType<T>	emptyRoleSemantic(String emptyRoleSemantic) Sets the empty-role-semantic element
List<HttpMethodConstraintType<ServletSecurityType<T>>>	getAllHttpMethodConstraint() Returns all http-method-constraint elements
List<String>	getAllRolesAllowed() Returns all roles-allowed elements
String	getEmptyRoleSemantic() Returns the empty-role-semantic element
HttpMethodConstraintType<ServletSecurityType<T>>	getOrCreateHttpMethodConstraint() If not already created, a new http-method-constraint element will be created and returned.
TransportGuaranteeType	getTransportGuarantee() Returns the transport-guarantee element
String	getTransportGuaranteeAsString() Returns the transport-guarantee element
ServletSecurityType<T>	removeAllHttpMethodConstraint() Removes all http-method-constraint elements
ServletSecurityType<T>	removeAllRolesAllowed() Removes the roles-allowed element
ServletSecurityType<T>	removeEmptyRoleSemantic() Removes the empty-role-semantic element
ServletSecurityType<T>	removeTransportGuarantee() Removes the transport-guarantee attribute
ServletSecurityType<T>	rolesAllowed(String... values) Creates for all String objects representing roles-allowed elements, a new roles-allowed element
ServletSecurityType<T>	transportGuarantee(String transportGuarantee) Sets the transport-guarantee element
ServletSecurityType<T>	transportGuarantee(TransportGuaranteeType transportGuarantee) Sets the transport-guarantee element

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

up

Method Detail

emptyRoleSemantic

ServletSecurityType<T> emptyRoleSemantic(String emptyRoleSemantic)

Sets the empty-role-semantic element

Parameters:

emptyRoleSemantic - the value for the element empty-role-semantic

Returns:

the current instance of ServletSecurityType

getEmptyRoleSemantic

String getEmptyRoleSemantic()

Returns the empty-role-semantic element

Returns:

the node defined for the element empty-role-semantic

removeEmptyRoleSemantic

ServletSecurityType<T> removeEmptyRoleSemantic()

Removes the empty-role-semantic element

Returns:

the current instance of ServletSecurityType

transportGuarantee

ServletSecurityType<T> transportGuarantee(TransportGuaranteeType transportGuarantee)

Sets the transport-guarantee element

Parameters:

transportGuarantee - the value for the element transport-guarantee

Returns:

the current instance of ServletSecurityType

transportGuarantee

ServletSecurityType<T> transportGuarantee(String transportGuarantee)

Sets the transport-guarantee element

Parameters:

transportGuarantee - the value for the element transport-guarantee

Returns:

the current instance of ServletSecurityType

getTransportGuarantee

TransportGuaranteeType getTransportGuarantee()

Returns the transport-guarantee element

Returns:

the value found for the element transport-guarantee

getTransportGuaranteeAsString

String getTransportGuaranteeAsString()

Returns the transport-guarantee element

Returns:

the value found for the element transport-guarantee

removeTransportGuarantee

ServletSecurityType<T> removeTransportGuarantee()

Removes the transport-guarantee attribute

Returns:

the current instance of ServletSecurityType

rolesAllowed

ServletSecurityType<T> rolesAllowed(String... values)

Creates for all String objects representing roles-allowed elements, a new roles-allowed element

Parameters:

values - list of roles-allowed objects

Returns:

the current instance of ServletSecurityType

getAllRolesAllowed

List<String> getAllRolesAllowed()

Returns all roles-allowed elements

Returns:

list of roles-allowed

removeAllRolesAllowed

ServletSecurityType<T> removeAllRolesAllowed()

Removes the roles-allowed element

Returns:

the current instance of ServletSecurityType

getOrCreateHttpMethodConstraint

HttpMethodConstraintType<ServletSecurityType<T>> getOrCreateHttpMethodConstraint()

If not already created, a new http-method-constraint element will be created and returned. Otherwise, the first existing http-method-constraint element will be returned.

Returns:

the instance defined for the element http-method-constraint

createHttpMethodConstraint

HttpMethodConstraintType<ServletSecurityType<T>> createHttpMethodConstraint()

Creates a new http-method-constraint element

Returns:

the new created instance of HttpMethodConstraintType>

getAllHttpMethodConstraint

List<HttpMethodConstraintType<ServletSecurityType<T>>> getAllHttpMethodConstraint()

Returns all http-method-constraint elements

Returns:

list of http-method-constraint

removeAllHttpMethodConstraint

ServletSecurityType<T> removeAllHttpMethodConstraint()

Removes all http-method-constraint elements

Returns:

the current instance of HttpMethodConstraintType>