me.adaptive.arp.api.ServiceSessionCookie Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of adaptive-arp-lib Show documentation
This is the AdaptiveMe Runtime Platform (ARP) API for Java platforms.
The newest version!
/**
--| ADAPTIVE RUNTIME PLATFORM |----------------------------------------------------------------------------------------

(C) Copyright 2013-2015 Carlos Lozano Diez t/a Adaptive.me .

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the
License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 . Unless required by appli-
-cable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS,  WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the  License  for the specific language governing
permissions and limitations under the License.

Original author:

    * Carlos Lozano Diez
            
            
            

Contributors:

    * Ferran Vila Conesa
             
             
             

    * See source code files for contributors.

Release:

    * @version v2.2.15

-------------------------------------------| aut inveniam viam aut faciam |--------------------------------------------
*/

package me.adaptive.arp.api;

import java.io.Serializable;

/**
   Structure representing the cookieValue of a http cookie.

   @author Aryslan
   @since v2.0
   @version 1.0
*/
public class ServiceSessionCookie extends APIBean implements Serializable {

     /**
        Java serialization support.
        @since 2.2.13
     */
     private static final long serialVersionUID = 100404270L;

     /**
        Name ot the cookie.
     */
     private String cookieName;
     /**
        Value of the ServiceCookie.
     */
     private String cookieValue;
     /**
        ServiceCookie creation timestamp in milliseconds.
     */
     private long creation;
     /**
        Domain for which the cookie is valid.
     */
     private String domain;
     /**
        ServiceCookie expiry in milliseconds or -1 for session only.
     */
     private long expiry;
     /**
        URI path for which the cookie is valid.
     */
     private String path;
     /**
        Scheme of the domain - http/https - for which the cookie is valid.
     */
     private String scheme;
     /**
        ServiceCookie is secure (https only).
     */
     private boolean secure;

     /**
        Default constructor.

        @since v2.0
     */
     public ServiceSessionCookie() {
     }

     /**
        Constructor used by the implementation

        @param cookieName  Name of the cookie
        @param cookieValue Value of the cookie
        @since v2.0
     */
     public ServiceSessionCookie(String cookieName, String cookieValue) {
          super();
          this.cookieName = cookieName;
          this.cookieValue = cookieValue;
     }

     /**
        Returns the cookie cookieName

        @return cookieName Name of the cookie
        @since v2.0
     */
     public String getCookieName() {
          return this.cookieName;
     }

     /**
        Set the cookie cookieName

        @param cookieName Name of the cookie
        @since v2.0
     */
     public void setCookieName(String cookieName) {
          this.cookieName = cookieName;
     }

     /**
        Returns the cookie cookieValue

        @return Value of the cookie
        @since v2.0
     */
     public String getCookieValue() {
          return this.cookieValue;
     }

     /**
        Set the cookie cookieValue

        @param cookieValue Value of the cookie
        @since v2.0
     */
     public void setCookieValue(String cookieValue) {
          this.cookieValue = cookieValue;
     }

     /**
        Returns the creation date

        @return Creation date of the cookie
        @since v2.0
     */
     public long getCreation() {
          return this.creation;
     }

     /**
        Sets the creation date

        @param creation Creation date of the cookie
        @since v2.0
     */
     public void setCreation(long creation) {
          this.creation = creation;
     }

     /**
        Returns the domain

        @return domain
        @since v2.0
     */
     public String getDomain() {
          return this.domain;
     }

     /**
        Set the domain

        @param domain Domain of the cookie
        @since v2.0
     */
     public void setDomain(String domain) {
          this.domain = domain;
     }

     /**
        Returns the expiration date in milis

        @return expiry
        @since v2.0
     */
     public long getExpiry() {
          return this.expiry;
     }

     /**
        Set the expiration date in milis

        @param expiry Expiration date of the cookie
        @since v2.0
     */
     public void setExpiry(long expiry) {
          this.expiry = expiry;
     }

     /**
        Returns the path

        @return path
        @since v2.0
     */
     public String getPath() {
          return this.path;
     }

     /**
        Set the path

        @param path Path of the cookie
        @since v2.0
     */
     public void setPath(String path) {
          this.path = path;
     }

     /**
        Returns the scheme

        @return scheme
        @since v2.0
     */
     public String getScheme() {
          return this.scheme;
     }

     /**
        Set the scheme

        @param scheme Scheme of the cookie
        @since v2.0
     */
     public void setScheme(String scheme) {
          this.scheme = scheme;
     }

     /**
        Returns whether the cookie is secure or not

        @return true if the cookie is secure; false otherwise
        @since v2.0
     */
     public boolean getSecure() {
          return this.secure;
     }

     /**
        Set whether the cookie is secure or not

        @param secure Privacy of the cookie
        @since v2.0
     */
     public void setSecure(boolean secure) {
          this.secure = secure;
     }


}

/**
------------------------------------| Engineered with ♥ in Barcelona, Catalonia |--------------------------------------
*/