001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common Development
008: * and Distribution License("CDDL") (collectively, the "License"). You
009: * may not use this file except in compliance with the License. You can obtain
010: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
011: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
012: * language governing permissions and limitations under the License.
013: *
014: * When distributing the software, include this License Header Notice in each
015: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
016: * Sun designates this particular file as subject to the "Classpath" exception
017: * as provided by Sun in the GPL Version 2 section of the License file that
018: * accompanied this code. If applicable, add the following below the License
019: * Header, with the fields enclosed by brackets [] replaced by your own
020: * identifying information: "Portions Copyrighted [year]
021: * [name of copyright owner]"
022: *
023: * Contributor(s):
024: *
025: * If you wish your version of this file to be governed by only the CDDL or
026: * only the GPL Version 2, indicate your decision by adding "[Contributor]
027: * elects to include this software in this distribution under the [CDDL or GPL
028: * Version 2] license." If you don't indicate a single choice of license, a
029: * recipient has the option to distribute your version of this file under
030: * either the CDDL, the GPL Version 2 or to extend the choice of license to
031: * its licensees as provided above. However, if you add GPL Version 2 code
032: * and therefore, elected the GPL Version 2 license, then the option applies
033: * only if the new code is made subject to such option by the copyright
034: * holder.
035: */
036: package com.sun.xml.ws.tx.coordinator;
037:
038: import com.sun.xml.ws.tx.common.Constants;
039:
040: import javax.xml.namespace.QName;
041: import javax.xml.ws.EndpointReference;
042: import java.util.Map;
043:
044: /**
045: * This interface hides the differences between the 2004/10 member submission and then 2006/03
046: * OASIS versions of CoordinationContext
047: *
048: * @author Ryan.Shoemaker@Sun.COM
049: * @version $Revision: 1.2 $
050: * @since 1.0
051: */
052: public interface CoordinationContextInterface {
053: /**
054: * Gets the value of the identifier property.
055: *
056: * @return the identifier value
057: */
058: String getIdentifier();
059:
060: /**
061: * Sets the value of the identifier property.
062: *
063: * @param identifier the identifier value
064: */
065: void setIdentifier(String identifier);
066:
067: /**
068: * Gets the value of the expires property in milliseconds.
069: *
070: * @return the value of the expires property in milliseconds
071: */
072: long getExpires();
073:
074: /**
075: * Sets the value of the expires property in milliseconds.
076: * <p/>
077: * The expires value can not be negative. Calling setExpires(0L)
078: * unsets the underlying Expires element in the CoordinationContext.
079: *
080: * @param expires the expires value in milliseconds
081: */
082: void setExpires(long expires);
083:
084: /**
085: * Gets the value of the coordinationType property.
086: *
087: * @return the value of the coordinationType
088: */
089: String getCoordinationType();
090:
091: /**
092: * Sets the value of the coordinationType property.
093: *
094: * @param coordinationType either {@link Constants#WSAT_2004_PROTOCOL} or
095: * {@link Constants#WSAT_OASIS_NSURI}
096: */
097: void setCoordinationType(String coordinationType);
098:
099: /**
100: * Gets the value of the registrationService property.
101: *
102: * @return the EndpointReference of the registration service
103: */
104: EndpointReference getRegistrationService();
105:
106: /**
107: * Sets the value of the registrationService property.
108: *
109: * @param registrationService the EndpointReference of the registration service
110: */
111: void setRegistrationService(EndpointReference registrationService);
112:
113: /**
114: * Return the underlying JAXB generated coordination context type.
115: * <p/>
116: * This will either be a (@link com.sun.xml.ws.tx.webservice.member.coord.CoordinationContext} or a
117: * OASIS CoordinationContext.
118: * <p/>
119: *
120: * @return Return the underlying JAXB generated coordination context type
121: */
122: Object getValue();
123:
124: /**
125: * Gets the underlying map that contains attributes that aren't bound to
126: * any typed property.
127: * <p/>
128: * the map is keyed by the name of the attribute and
129: * the value is the string value of the attribute.
130: * <p/>
131: * the map returned by this method is live, and you can add new attribute
132: * by updating the map directly. Because of this design, there's no setter.
133: *
134: * @return always non-null
135: */
136: public Map<QName, String> getOtherAttributes();
137:
138: /**
139: * Set the root registration service EPR for this coordination context
140: *
141: * @param rootRegistrationService
142: */
143: public void setRootCoordinatorRegistrationService(
144: EndpointReference rootRegistrationService);
145:
146: /**
147: * Get the root registration service EPR
148: *
149: * @return the root registration service epr
150: */
151: public EndpointReference getRootRegistrationService();
152:
153: }
|