org.eclipse.modisco.jee.webapp.webapp30
Interface CookieConfigType


public interface CookieConfigType

A representation of the model object 'Cookie Config Type'. The cookie-configType defines the configuration for the session tracking cookies of this web application. Used in: session-config

The following features are supported:

See Also:
Webapp30Package.getCookieConfigType()
Generated:
Model:
extendedMetaData="name='cookie-configType' kind='elementOnly'"

Method Summary
 CookieCommentType getComment()
          Returns the value of the 'Comment' containment reference.
 CookieDomainType getDomain()
          Returns the value of the 'Domain' containment reference.
 TrueFalseType getHttpOnly()
          Returns the value of the 'Http Only' containment reference.
 java.lang.String getId()
          Returns the value of the 'Id' attribute.
 XsdIntegerType getMaxAge()
          Returns the value of the 'Max Age' containment reference.
 CookieNameType getName()
          Returns the value of the 'Name' containment reference.
 CookiePathType getPath()
          Returns the value of the 'Path' containment reference.
 TrueFalseType getSecure()
          Returns the value of the 'Secure' containment reference.
 void setComment(CookieCommentType value)
          Sets the value of the 'Comment' containment reference.
 void setDomain(CookieDomainType value)
          Sets the value of the 'Domain' containment reference.
 void setHttpOnly(TrueFalseType value)
          Sets the value of the 'Http Only' containment reference.
 void setId(java.lang.String value)
          Sets the value of the 'Id' attribute.
 void setMaxAge(XsdIntegerType value)
          Sets the value of the 'Max Age' containment reference.
 void setName(CookieNameType value)
          Sets the value of the 'Name' containment reference.
 void setPath(CookiePathType value)
          Sets the value of the 'Path' containment reference.
 void setSecure(TrueFalseType value)
          Sets the value of the 'Secure' containment reference.
 

Method Detail

getName

CookieNameType getName()
Returns the value of the 'Name' containment reference. The name that will be assigned to any session tracking cookies created by this web application. The default is JSESSIONID

Returns:
the value of the 'Name' containment reference.
See Also:
setName(CookieNameType), Webapp30Package.getCookieConfigType_Name()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='name' namespace='http://java.sun.com/xml/ns/javaee'"

setName

void setName(CookieNameType value)
Sets the value of the 'Name' containment reference.

Parameters:
value - the new value of the 'Name' containment reference.
See Also:
getName()
Generated:

getDomain

CookieDomainType getDomain()
Returns the value of the 'Domain' containment reference. The domain name that will be assigned to any session tracking cookies created by this web application.

Returns:
the value of the 'Domain' containment reference.
See Also:
setDomain(CookieDomainType), Webapp30Package.getCookieConfigType_Domain()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='domain' namespace='http://java.sun.com/xml/ns/javaee'"

setDomain

void setDomain(CookieDomainType value)
Sets the value of the 'Domain' containment reference.

Parameters:
value - the new value of the 'Domain' containment reference.
See Also:
getDomain()
Generated:

getPath

CookiePathType getPath()
Returns the value of the 'Path' containment reference. The path that will be assigned to any session tracking cookies created by this web application.

Returns:
the value of the 'Path' containment reference.
See Also:
setPath(CookiePathType), Webapp30Package.getCookieConfigType_Path()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='path' namespace='http://java.sun.com/xml/ns/javaee'"

setPath

void setPath(CookiePathType value)
Sets the value of the 'Path' containment reference.

Parameters:
value - the new value of the 'Path' containment reference.
See Also:
getPath()
Generated:

getComment

CookieCommentType getComment()
Returns the value of the 'Comment' containment reference. The comment that will be assigned to any session tracking cookies created by this web application.

Returns:
the value of the 'Comment' containment reference.
See Also:
setComment(CookieCommentType), Webapp30Package.getCookieConfigType_Comment()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='comment' namespace='http://java.sun.com/xml/ns/javaee'"

setComment

void setComment(CookieCommentType value)
Sets the value of the 'Comment' containment reference.

Parameters:
value - the new value of the 'Comment' containment reference.
See Also:
getComment()
Generated:

getHttpOnly

TrueFalseType getHttpOnly()
Returns the value of the 'Http Only' containment reference. Specifies whether any session tracking cookies created by this web application will be marked as HttpOnly

Returns:
the value of the 'Http Only' containment reference.
See Also:
setHttpOnly(TrueFalseType), Webapp30Package.getCookieConfigType_HttpOnly()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='http-only' namespace='http://java.sun.com/xml/ns/javaee'"

setHttpOnly

void setHttpOnly(TrueFalseType value)
Sets the value of the 'Http Only' containment reference.

Parameters:
value - the new value of the 'Http Only' containment reference.
See Also:
getHttpOnly()
Generated:

getSecure

TrueFalseType getSecure()
Returns the value of the 'Secure' containment reference. Specifies whether any session tracking cookies created by this web application will be marked as secure even if the request that initiated the corresponding session is using plain HTTP instead of HTTPS

Returns:
the value of the 'Secure' containment reference.
See Also:
setSecure(TrueFalseType), Webapp30Package.getCookieConfigType_Secure()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='secure' namespace='http://java.sun.com/xml/ns/javaee'"

setSecure

void setSecure(TrueFalseType value)
Sets the value of the 'Secure' containment reference.

Parameters:
value - the new value of the 'Secure' containment reference.
See Also:
getSecure()
Generated:

getMaxAge

XsdIntegerType getMaxAge()
Returns the value of the 'Max Age' containment reference. The lifetime (in seconds) that will be assigned to any session tracking cookies created by this web application. Default is -1

Returns:
the value of the 'Max Age' containment reference.
See Also:
setMaxAge(XsdIntegerType), Webapp30Package.getCookieConfigType_MaxAge()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='max-age' namespace='http://java.sun.com/xml/ns/javaee'"

setMaxAge

void setMaxAge(XsdIntegerType value)
Sets the value of the 'Max Age' containment reference.

Parameters:
value - the new value of the 'Max Age' containment reference.
See Also:
getMaxAge()
Generated:

getId

java.lang.String getId()
Returns the value of the 'Id' attribute.

If the meaning of the 'Id' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Id' attribute.
See Also:
setId(String), Webapp30Package.getCookieConfigType_Id()
Generated:
Model:
id="true" dataType="org.eclipse.emf.ecore.xml.type.ID" extendedMetaData="kind='attribute' name='id'"

setId

void setId(java.lang.String value)
Sets the value of the 'Id' attribute.

Parameters:
value - the new value of the 'Id' attribute.
See Also:
getId()
Generated: