1 /*
   2  * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package com.sun.xml.internal.ws.api.ha;
  27 
  28 
  29 /**
  30  * Provides a way to tell the runtime about stickiness of requests. In a
  31  * HA environment, a client's requests need to land on the same instance so
  32  * that a {@link com.sun.org.glassfish.ha.store.api.BackingStore} entry for a key is
  33  * accessed/modified from the same instance.
  34  *
  35  * <p>
  36  * A web service feature may implement this interface. JAX-WS runtime
  37  * checks if any feature needs stickiness of requests, and if HA is configured
  38  * ({@link HighAvailabilityProvider#isHaEnvironmentConfigured()}), it will take
  39  * an appropriate action. For example, in servlet transport, it would create
  40  * JSESSIONID cookie so that a typical loadbalancer would stick the subsequent
  41  * client requests to the same instance.
  42  *
  43  * @author Jitendra Kotamraju
  44  * @since JAX-WS RI 2.2.2
  45  */
  46 public interface StickyFeature {
  47 }