src/share/jaxws_classes/com/sun/xml/internal/ws/api/ha/HaInfo.java

Tue, 09 Apr 2013 14:51:13 +0100

author
alanb
date
Tue, 09 Apr 2013 14:51:13 +0100
changeset 368
0989ad8c0860
parent 286
f50545b5e2f1
child 637
9c07ef4934dd
permissions
-rw-r--r--

8010393: Update JAX-WS RI to 2.2.9-b12941
Reviewed-by: alanb, erikj
Contributed-by: miroslav.kos@oracle.com, martin.grebac@oracle.com

ohair@286 1 /*
alanb@368 2 * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
ohair@286 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286 4 *
ohair@286 5 * This code is free software; you can redistribute it and/or modify it
ohair@286 6 * under the terms of the GNU General Public License version 2 only, as
ohair@286 7 * published by the Free Software Foundation. Oracle designates this
ohair@286 8 * particular file as subject to the "Classpath" exception as provided
ohair@286 9 * by Oracle in the LICENSE file that accompanied this code.
ohair@286 10 *
ohair@286 11 * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
ohair@286 14 * version 2 for more details (a copy is included in the LICENSE file that
ohair@286 15 * accompanied this code).
ohair@286 16 *
ohair@286 17 * You should have received a copy of the GNU General Public License version
ohair@286 18 * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286 20 *
ohair@286 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286 22 * or visit www.oracle.com if you need additional information or have any
ohair@286 23 * questions.
ohair@286 24 */
ohair@286 25
ohair@286 26 package com.sun.xml.internal.ws.api.ha;
ohair@286 27
ohair@286 28 import com.sun.xml.internal.ws.api.message.Packet;
ohair@286 29
ohair@286 30 /**
ohair@286 31 * This class has HA information
ohair@286 32 * <p>
ohair@286 33 *
ohair@286 34 * This would help a loadbalancer to put the request(in case of a fail-over)
ohair@286 35 * on a replica instance that has all the related data. Even if there is no
ohair@286 36 * loadbalancer, a backing store could locate the information by directly
ohair@286 37 * going to the correct replica instance. This would also help any part of
ohair@286 38 * the runtime to know about failover case(and in-turn may invalidate
ohair@286 39 * local caches).
ohair@286 40 *
ohair@286 41 * <p>
ohair@286 42 * To achieve this functionality, it carries two pieces of information:
ohair@286 43 * <ol>
ohair@286 44 * <li>key - Related {@link com.sun.org.glassfish.ha.store.api.BackingStore} keys can
ohair@286 45 * use this info for their HashableKey impl. First store creates this object,
ohair@286 46 * and subsequent related stores use the same key.
ohair@286 47 * <li>replicaInstance - where the related info is replicated
ohair@286 48 * </ol>
ohair@286 49 *
ohair@286 50 * <p>
ohair@286 51 * This can be accessed from {@link Packet} using {@link Packet#HA_INFO}
ohair@286 52 * property by the runtime. This object is created typically
ohair@286 53 * <ul>
ohair@286 54 * <li> When a store happens for the first time
ohair@286 55 * <li> A subsequent inbound transport creates from cookies
ohair@286 56 * <li> A fail-over request stores the data to a different replica
ohair@286 57 * </ul>
ohair@286 58 *
ohair@286 59 * @author Jitendra Kotamraju
ohair@286 60 * @since JAX-WS RI 2.2.2
ohair@286 61 */
ohair@286 62 public class HaInfo {
ohair@286 63 private final String replicaInstance;
ohair@286 64 private final String key;
ohair@286 65 private final boolean failOver;
ohair@286 66
ohair@286 67 public HaInfo(String key, String replicaInstance, boolean failOver) {
ohair@286 68 this.key = key;
ohair@286 69 this.replicaInstance = replicaInstance;
ohair@286 70 this.failOver = failOver;
ohair@286 71 }
ohair@286 72
ohair@286 73 public String getReplicaInstance() {
ohair@286 74 return replicaInstance;
ohair@286 75 }
ohair@286 76
ohair@286 77 public String getKey() {
ohair@286 78 return key;
ohair@286 79 }
ohair@286 80
ohair@286 81 public boolean isFailOver() {
ohair@286 82 return failOver;
ohair@286 83 }
ohair@286 84 }

mercurial