atom.ws.model.ClientRequestContext Maven / Gradle / Ivy

Go to download
/*
 * Copyright © 2015 Geeoz, and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * The Research Projects is dual-licensed under the GNU General Public
 * License, version 2.0 (GPLv2) and the Geeoz Commercial License.
 *
 * Solely for non-commercial purposes. A purpose is non-commercial only if
 * it is in no manner primarily intended for or directed toward commercial
 * advantage or private monetary compensation.
 *
 * This Geeoz Software is supplied to you by Geeoz in consideration of your
 * agreement to the following terms, and your use, installation, modification
 * or redistribution of this Geeoz Software constitutes acceptance of these
 * terms. If you do not agree with these terms, please do not use, install,
 * modify or redistribute this Geeoz Software.
 *
 * Neither the name, trademarks, service marks or logos of Geeoz may be used
 * to endorse or promote products derived from the Geeoz Software without
 * specific prior written permission from Geeoz.
 *
 * The Geeoz Software is provided by Geeoz on an "AS IS" basis. GEEOZ MAKES NO
 * WARRANTIES, EXPRESS  OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
 * WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE, REGARDING THE GEEOZ SOFTWARE OR ITS USE AND OPERATION ALONE OR IN
 * COMBINATION WITH YOUR PRODUCTS.
 *
 * IN NO EVENT SHALL GEEOZ BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL
 * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION
 * AND/OR DISTRIBUTION OF THE GEEOZ SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER
 * THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR
 * OTHERWISE, EVEN IF GEEOZ HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * A copy of the GNU General Public License is included in the distribution in
 * the file LICENSE and at
 *
 *     http://www.gnu.org/licenses/gpl-2.0.html
 *
 * If you are using the Research Projects for commercial purposes, we
 * encourage you to visit
 *
 *     http://products.geeoz.com/license
 *
 * for more details.
 *
 * This software or hardware and documentation may provide access to
 * or information on content, products, and services from third parties.
 * Geeoz and its affiliates are not responsible for and expressly disclaim
 * all warranties of any kind with respect to third-party content, products,
 * and services. Geeoz and its affiliates will not be responsible for any loss,
 * costs, or damages incurred due to your access to or use of third-party
 * content, products, or services. If a third-party content exists, the
 * additional copyright notices and license terms applicable to portions of the
 * software are set forth in the THIRD_PARTY_LICENSE_README file.
 *
 * Please contact Geeoz or visit www.geeoz.com if you need additional
 * information or have any questions.
 */

package atom.ws.model;

import javax.servlet.http.HttpSession;
import java.util.Arrays;
import java.util.Locale;
import java.util.Objects;

/**
 * Client request context containing http session
 * and client attributes.
 *
 * @author Serge Voloshyn
 * @version 1.2 3/1/15
 */
public final class ClientRequestContext {
    /**
     * Current client session.
     */
    private final HttpSession session;
    /**
     * Current client cookies.
     */
    private final Cookie[] requestCookies;
    /**
     * Preferred client locale.
     */
    private final Locale locale;
    /**
     * New cookies for client.
     */
    private Cookie[] responseCookies;

    /**
     * Default constructor.
     *
     * @param aSession     current client session
     * @param clientLocale preferred client locale
     * @param cookies      current client cookies
     */
    public ClientRequestContext(final HttpSession aSession,
                                final Locale clientLocale,
                                final Cookie[] cookies) {
        session = aSession;
        if (cookies == null) {
            requestCookies = null;
        } else {
            requestCookies = Arrays.copyOf(cookies, cookies.length);
        }
        locale = clientLocale;
    }

    /**
     * Create client request context.
     *
     * @param aSession current client session
     * @param locale   preferred client locale
     * @param cookies  current client cookies
     * @return new client context
     */
    public static ClientRequestContext create(final HttpSession aSession,
                                              final Locale locale,
                                              final javax.servlet.http.Cookie[]
                                                      cookies) {
        final Cookie[] tmp;
        if (cookies != null && cookies.length > 0) {
            tmp = new Cookie[cookies.length];
            for (int idx = 0; idx < cookies.length; idx++) {
                final javax.servlet.http.Cookie cookie = cookies[idx];
                tmp[idx] = new Cookie(cookie.getName(), cookie.getValue());
            }
        } else {
            tmp = null;
        }
        return new ClientRequestContext(aSession, locale, tmp);
    }

    /**
     * Get current client session.
     *
     * @return current client session
     */
    public HttpSession getSession() {
        return session;
    }

    /**
     * Get current request cookies.
     *
     * @return current request cookies
     */
    public Cookie[] getRequestCookies() {
        if (requestCookies == null) {
            return new Cookie[0];
        }
        return Arrays.copyOf(requestCookies, requestCookies.length);
    }

    /**
     * Get new cookies for client.
     *
     * @return new cookies for client
     */
    public Cookie[] getResponseCookies() {
        if (responseCookies == null) {
            return new Cookie[0];
        }
        return Arrays.copyOf(responseCookies, responseCookies.length);
    }

    /**
     * Returns preferred client locale.
     *
     * @return preferred client locale
     */
    public Locale getLocale() {
        return locale;
    }

    /**
     * Set new cookies for client.
     *
     * @param theResponseCookies new cookies for client
     */
    public void setResponseCookies(final Cookie[] theResponseCookies) {
        if (theResponseCookies == null) {
            responseCookies = null;
        } else {
            responseCookies = Arrays.copyOf(theResponseCookies,
                    theResponseCookies.length);
        }
    }

    @Override
    public boolean equals(final Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null || getClass() != obj.getClass()) {
            return false;
        }

        final ClientRequestContext that = (ClientRequestContext) obj;
        return Objects.equals(session, that.session)
                && Objects.equals(locale, that.locale)
                && Arrays.equals(requestCookies, that.requestCookies)
                && Arrays.equals(responseCookies, that.responseCookies);
    }

    @Override
    public int hashCode() {
        return Objects.hash(session, requestCookies);
    }

    @Override
    public String toString() {
        return String.format("ClientRequestContext {session='%s', locale='%s'}"
                        .concat("requestCookies='%s', responseCookies='%s'"),
                session.getId(), locale, Arrays.toString(requestCookies),
                Arrays.toString(responseCookies));
    }
}