Cookie

java.lang.Object
- com.softwareag.mobile.runtime.toolkit.rest.Cookie

```
public class Cookie
extends java.lang.Object
```
Implementation of a HTTP Cookie, including all parsing from different versions of commonly used standards to use Cookies in a stateful HTTP server communication.
Supported attributes:
- name and value of the Cookie
- domain, path and portlist
- secure
All other attributes are currently not supported.
Version:

9.12.0.0000-0266

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String HEADER_COOKIE

static java.lang.String HEADER_SET_COOKIE

static java.lang.String HEADER_SET_COOKIE2

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`HEADER_COOKIE`
`static java.lang.String`	`HEADER_SET_COOKIE`
`static java.lang.String`	`HEADER_SET_COOKIE2`

Constructor Summary

Constructors
Constructor and Description

Cookie(java.lang.String name, java.lang.String value)
Creates a new Cookie with the given name and value.

Constructors
Constructor and Description
`Cookie(java.lang.String name, java.lang.String value)` Creates a new Cookie with the given name and value.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object object)`
`static java.util.Vector`	`getCookiesFromHeader(java.lang.String header)` Parses all `Cookie`s from the given HTTP header field.
`java.lang.String`	`getDomain()` Returns the domain of the `Cookie`.
`java.lang.String`	`getName()` Returns the name of the `Cookie`.
`java.lang.String`	`getPath()` Returns the path of the `Cookie`.
`java.lang.String`	`getPortlist()` Returns the port list attribute of the `Cookie`.
`long`	`getTimeCreated()` Returns the time the `Cookie` was created.
`java.lang.String`	`getValue()` Returns the value of the `Cookie`.
`boolean`	`isDomainFromURL()` Returns a flag to indicate if the domain of the `Cookie` was parsed from an URL using `setDomainFromURL(String)`.
`boolean`	`isSecure()` Returns the secure attribute of the `Cookie`.
`boolean`	`matchesURL(java.lang.String url)` Checks if the `Cookie` matches the given URL using the domain, path and secure attributes.
`void`	`setDomain(java.lang.String domain)` Sets the domain of the `Cookie`.
`void`	`setDomainFromURL(java.lang.String url)` Sets the domain of the `Cookie` from a given URL.
`void`	`setName(java.lang.String name)` Sets the name of the `Cookie`.
`void`	`setPath(java.lang.String path)` Sets the path of the `Cookie`.
`void`	`setPathFromURL(java.lang.String url)` Sets the path of the `Cookie` from a given URL.
`void`	`setPortlist(java.lang.String portlist)` Sets the port list of the `Cookie`.
`void`	`setSecure(boolean secure)` Sets the secure attribute of the `Cookie`.
`void`	`setTimeCreated(long created)` Sets the time the `Cookie` was created
`void`	`setValue(java.lang.String value)` Sets the value of the `Cookie`.
`java.lang.String`	`toString()` Returns a String representation of the Cookies name and value that can be used in the HTTP Cookie header.
`java.lang.String`	`toVersion2String()` Returns an extended String representation of the Cookie that can be used in the HTTP Cookie header.

Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - HEADER_COOKIE
```
public static final java.lang.String HEADER_COOKIE
```
    See Also:
    
    Constant Field Values
  - HEADER_SET_COOKIE
```
public static final java.lang.String HEADER_SET_COOKIE
```
    See Also:
    
    Constant Field Values
  - HEADER_SET_COOKIE2
```
public static final java.lang.String HEADER_SET_COOKIE2
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Cookie
```
public Cookie(java.lang.String name,
              java.lang.String value)
```
    Creates a new Cookie with the given name and value. If name and value arguments are not valid, an IllegalArgumentException will be thrown. Typically this will be caused by illegal characters or the use of reserverd words in the name of the Cookie.
    
    Parameters:
    
    name - the name of the Cookie
    
    value - the value of the Cookie
- Method Detail
  - getCookiesFromHeader
```
public static java.util.Vector getCookiesFromHeader(java.lang.String header)
```
    Parses all Cookies from the given HTTP header field. There might be more than one Cookie set by the HTTP backend server. Both, Set-Cookie and Set-Cookie2 headers are supported.
    
    Parameters:
    
    header - the header String
    
    Returns:
    
    a Vector with all Cookies parsed from the header String
  - equals
```
public boolean equals(java.lang.Object object)
```
    Overrides:
    
    equals in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Returns a String representation of the Cookies name and value that can be used in the HTTP Cookie header.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    the Cookie as String
  - toVersion2String
```
public java.lang.String toVersion2String()
```
    Returns an extended String representation of the Cookie that can be used in the HTTP Cookie header. It contains not only name and value, but also it's domain, path and portlist attributes.
    
    Returns:
    
    the Cookie as String
  - matchesURL
```
public boolean matchesURL(java.lang.String url)
```
    Checks if the Cookie matches the given URL using the domain, path and secure attributes.
    
    Parameters:
    
    url - the URL as String
    
    Returns:
    
    true if the Cookie matches the URL and might be used in a request using the given URL, false if not
  - getName
```
public java.lang.String getName()
```
    Returns the name of the Cookie.
    
    Returns:
    
    the name as String
  - setName
```
public void setName(java.lang.String name)
```
    Sets the name of the Cookie.
    
    Parameters:
    
    name - as String
  - getValue
```
public java.lang.String getValue()
```
    Returns the value of the Cookie.
    
    Returns:
    
    the value as String
  - setValue
```
public void setValue(java.lang.String value)
```
    Sets the value of the Cookie.
    
    Parameters:
    
    value - as String
  - getDomain
```
public java.lang.String getDomain()
```
    Returns the domain of the Cookie.
    
    Returns:
    
    the domain as String
  - setDomain
```
public void setDomain(java.lang.String domain)
```
    Sets the domain of the Cookie.
    
    Parameters:
    
    domain - as String
  - setDomainFromURL
```
public void setDomainFromURL(java.lang.String url)
```
    Sets the domain of the Cookie from a given URL.
    
    Parameters:
    
    url - as String to parse the domain from
  - getPath
```
public java.lang.String getPath()
```
    Returns the path of the Cookie.
    
    Returns:
    
    the path as String
  - setPath
```
public void setPath(java.lang.String path)
```
    Sets the path of the Cookie.
    
    Parameters:
    
    path - as String
  - setPathFromURL
```
public void setPathFromURL(java.lang.String url)
```
    Sets the path of the Cookie from a given URL.
    
    Parameters:
    
    url - as String to parse the path from
  - getPortlist
```
public java.lang.String getPortlist()
```
    Returns the port list attribute of the Cookie.
    
    Returns:
    
    the port list as String
  - setPortlist
```
public void setPortlist(java.lang.String portlist)
```
    Sets the port list of the Cookie.
    
    Parameters:
    
    portList - as String
  - isSecure
```
public boolean isSecure()
```
    Returns the secure attribute of the Cookie.
    
    Returns:
    
    true if the Cookie requires secure connections, false if not.
  - setSecure
```
public void setSecure(boolean secure)
```
    Sets the secure attribute of the Cookie.
    
    Parameters:
    
    secure - value as boolean
  - getTimeCreated
```
public long getTimeCreated()
```
    Returns the time the Cookie was created. This enables to calculate the age of the Cookie.
    
    Returns:
  - setTimeCreated
```
public void setTimeCreated(long created)
```
    Sets the time the Cookie was created
    
    Parameters:
    
    created - value as long.
  - isDomainFromURL
```
public boolean isDomainFromURL()
```
    Returns a flag to indicate if the domain of the Cookie was parsed from an URL using setDomainFromURL(String).
    
    Returns:
    
    true if the domain and path were parsed from an URL, false if not.

Class Cookie

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

HEADER_COOKIE

HEADER_SET_COOKIE

HEADER_SET_COOKIE2

Constructor Detail

Cookie

Method Detail

getCookiesFromHeader

equals

toString

toVersion2String

matchesURL

getName

setName

getValue

setValue

getDomain

setDomain

setDomainFromURL

getPath

setPath

setPathFromURL

getPortlist

setPortlist

isSecure

setSecure

getTimeCreated

setTimeCreated

isDomainFromURL