# WebRequestContext.java

    /*
    ** Module   : WebRequestContext.java
    ** Abstract : A container with the data associated with an authorized web request.
    **
    ** Copyright (c) 2022, Golden Code Development Corporation.
    **
    ** -#- -I- --Date-- ------------------------------------Description-------------------------------------------
    ** 001 CA  20220404 Created the first version.
    */
    /*
    ** This program is free software: you can redistribute it and/or modify
    ** it under the terms of the GNU Affero General Public License as
    ** published by the Free Software Foundation, either version 3 of the
    ** License, or (at your option) any later version.
    **
    ** This program is distributed in the hope that it will be useful,
    ** but WITHOUT ANY WARRANTY; without even the implied warranty of
    ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    ** GNU Affero General Public License for more details.
    **
    ** You may find a copy of the GNU Affero GPL version 3 at the following
    ** location: https://www.gnu.org/licenses/agpl-3.0.en.html
    **
    ** Additional terms under GNU Affero GPL version 3 section 7:
    **
    **   Under Section 7 of the GNU Affero GPL version 3, the following additional
    **   terms apply to the works covered under the License.  These additional terms
    **   are non-permissive additional terms allowed under Section 7 of the GNU
    **   Affero GPL version 3 and may not be removed by you.
    **
    **   0. Attribution Requirement.
    **
    **     You must preserve all legal notices or author attributions in the covered
    **     work or Appropriate Legal Notices displayed by works containing the covered
    **     work.  You may not remove from the covered work any author or developer
    **     credit already included within the covered work.
    **
    **   1. No License To Use Trademarks.
    **
    **     This license does not grant any license or rights to use the trademarks
    **     Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
    **     of Golden Code Development Corporation. You are not authorized to use the
    **     name Golden Code, FWD, or the names of any author or contributor, for
    **     publicity purposes without written authorization.
    **
    **   2. No Misrepresentation of Affiliation.
    **
    **     You may not represent yourself as Golden Code Development Corporation or FWD.
    **
    **     You may not represent yourself for publicity purposes as associated with
    **     Golden Code Development Corporation, FWD, or any author or contributor to
    **     the covered work, without written authorization.
    **
    **   3. No Misrepresentation of Source or Origin.
    **
    **     You may not represent the covered work as solely your work.  All modified
    **     versions of the covered work must be marked in a reasonable way to make it
    **     clear that the modified work is not originating from Golden Code Development
    **     Corporation or FWD.  All modified versions must contain the notices of
    **     attribution required in this license.
    */

    package com.goldencode.p2j.security;

    /**
     * Contains the state about an authorized web request.
     * <p>
     * Instances of this class are set as the FWD context ID, to identify the FWD session.
     */
    class WebRequestContext
    {
       /** The context switched used to perform the request using a specific context. */
       private final ContextSwitcher contextSwitcher;

       /** The web service authentication token. */
       private final String token;

       /** The FWD account used to execute the target API, for this web request. */
       private final String account;

       /** The expiration time (in millis) of this context. */
       private final long end;

       /**
        * The timeout (in seconds) of this context.  If it is set to 0, it must be destroyed explicitly, via
        * logout.
        */
       private int timeout;

       /**
        * Create a new instance.
        *
        * @param    contextSwitcher
        *           The context switched used to perform the request using a specific context.
        * @param    token
        *           The web service authentication token.
        * @param    account
        *           The FWD account used to execute the target API, for this web request.
        * @param    timeout
        *           The timeout of this context.  If it is set to 0, it must be destroyed explicitly, via logout.
        */
       public WebRequestContext(ContextSwitcher contextSwitcher,
                                String          token,
                                String          account,
                                int             timeout)
       {
          this.contextSwitcher = contextSwitcher;
          this.token           = token;
          this.account         = account;
          this.timeout         = timeout;

          this.end = System.currentTimeMillis() + timeout * 1000;
       }

       /**
        * Get the {@link #contextSwitcher}.
        *
        * @return   See above.
        */
       ContextSwitcher getContextSwitcher()
       {
          return contextSwitcher;
       }

       /**
        * Get the {@link #token}.
        *
        * @return   See above.
        */
       String getToken()
       {
          return token;
       }

       /**
        * Get the {@link #account}.
        *
        * @return   See above.
        */
       String getAccount()
       {
          return account;
       }

       /**
        * Check if the web request context has expired and needs to be destroyed.
        *
        * @return   <code>true</code> if timeout is not zero and the {@link #end} time has passed.
        */
       boolean isExpired()
       {
          return timeout != 0 && end <= System.currentTimeMillis();
       }
    }