org.jboss.shrinkwrap.descriptor.api.webcommon30

Interface SessionConfigType<T>

All Superinterfaces:

Child<T>, JavaeeSessionConfigCommonType<T,SessionConfigType<T>>

public interface SessionConfigType<T>
extends Child<T>, JavaeeSessionConfigCommonType<T,SessionConfigType<T>>

This interface defines the contract for the session-configType xsd type

Author:

Ralf Battenfeld, Andrew Lee Rubinger, George Gastaldi

Method Summary

Modifier and Type	Method and Description
List<String>	getAllTrackingMode() Returns all tracking-mode elements
String	getId() Returns the id attribute
CookieConfigType<SessionConfigType<T>>	getOrCreateCookieConfig() If not already created, a new cookie-config element with the given value will be created.
Integer	getSessionTimeout() Returns the session-timeout element
SessionConfigType<T>	id(String id) Sets the id attribute
SessionConfigType<T>	removeAllTrackingMode() Removes the tracking-mode element
SessionConfigType<T>	removeCookieConfig() Removes the cookie-config element
SessionConfigType<T>	removeId() Removes the id attribute
SessionConfigType<T>	removeSessionTimeout() Removes the session-timeout element
SessionConfigType<T>	sessionTimeout(Integer sessionTimeout) Sets the session-timeout element
SessionConfigType<T>	trackingMode(String... values) Creates for all String objects representing tracking-mode elements, a new tracking-mode element
SessionConfigType<T>	trackingMode(TrackingModeType... values) Creates for all javaee:tracking-modeType objects representing tracking-mode elements, a new tracking-mode element

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

up

Method Detail

sessionTimeout

SessionConfigType<T> sessionTimeout(Integer sessionTimeout)

Sets the session-timeout element

Parameters:

sessionTimeout - the value for the element session-timeout

Returns:

the current instance of SessionConfigType

getSessionTimeout

Integer getSessionTimeout()

Returns the session-timeout element

Returns:

the node defined for the element session-timeout

removeSessionTimeout

SessionConfigType<T> removeSessionTimeout()

Removes the session-timeout element

Returns:

the current instance of SessionConfigType

getOrCreateCookieConfig

CookieConfigType<SessionConfigType<T>> getOrCreateCookieConfig()

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

Returns:

a new or existing instance of CookieConfigType>

removeCookieConfig

SessionConfigType<T> removeCookieConfig()

Removes the cookie-config element

Returns:

the current instance of SessionConfigType

trackingMode

SessionConfigType<T> trackingMode(TrackingModeType... values)

Creates for all javaee:tracking-modeType objects representing tracking-mode elements, a new tracking-mode element

Parameters:

values - list of tracking-mode objects

Returns:

the current instance of SessionConfigType

trackingMode

SessionConfigType<T> trackingMode(String... values)

Creates for all String objects representing tracking-mode elements, a new tracking-mode element

Parameters:

values - list of tracking-mode objects

Returns:

the current instance of SessionConfigType

getAllTrackingMode

List<String> getAllTrackingMode()

Returns all tracking-mode elements

Returns:

list of tracking-mode

removeAllTrackingMode

SessionConfigType<T> removeAllTrackingMode()

Removes the tracking-mode element

Returns:

the current instance of SessionConfigType

id

SessionConfigType<T> id(String id)

Sets the id attribute

Parameters:

id - the value for the attribute id

Returns:

the current instance of SessionConfigType

getId

String getId()

Returns the id attribute

Returns:

the value defined for the attribute id

removeId

SessionConfigType<T> removeId()

Removes the id attribute

Returns:

the current instance of SessionConfigType