/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can obtain
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.xml.ws.tx.coordinator;
import com.sun.istack.NotNull;
import com.sun.istack.Nullable;
import com.sun.xml.ws.api.tx.Protocol;
import static com.sun.xml.ws.api.tx.Protocol.*;
import com.sun.xml.ws.developer.MemberSubmissionEndpointReference;
import com.sun.xml.ws.tx.common.Identifier;
import com.sun.xml.ws.tx.common.RegistrantIdentifier;
import com.sun.xml.ws.tx.common.TxLogger;
import com.sun.xml.ws.tx.webservice.member.coord.RegisterType;
import javax.xml.ws.EndpointReference;
import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.Semaphore;
import java.util.concurrent.TimeUnit;
import java.util.logging.Level;
/**
* This class encapsulates a coordination registrant.
* <p/>
* The coordination protocol implementations will extend this class and
* add protocol specific functionality.
*
* @author Ryan.Shoemaker@Sun.COM
* @version $Revision: 1.7.2.1 $
* @since 1.0
*/
public abstract class Registrant {
/* The actual SOAP message containing the register message */
private RegisterType registerRequest = null;
/* reference to the parent coordinator */
private final Coordinator parent;
/* the protocol the registrant is registering for */
private final Protocol protocol;
// coordinator(received from coord:registerReply from coordinator)
private EndpointReference coordinatorProtocolService = null;
private static long nextId = 1;
private final RegistrantIdentifier id;
static private TxLogger logger = TxLogger.getCoordLogger(Registrant.class);
// only set to false when constucting a Registrant with a remote coordination service.
// when this value is true, coordination protocol service will be properly set.
private Boolean registrationCompleted = true;
/* mutex used for asynch register / registerResponse MEP with REMOTE CPS */
private Semaphore registrationCompletedGate;
/**
* Create a new registrant
*
* @param registerRequest <register> request
* @param parent parent coordinator
*/
public Registrant(@NotNull Coordinator parent, @NotNull RegisterType registerRequest) {
this(parent, registerRequest.getProtocolIdentifier());
this.registerRequest = registerRequest;
// no need to add to outstanding registrants, the PPS is in registerRequest
}
protected Registrant(Coordinator parent, String protocolId) {
this(parent, Protocol.getProtocol(protocolId));
}
/**
* Create a Registratant with its coordinator parent for protocol.
*
* @param parent parent coordinator
* @param protocol activity protocol
*/
protected Registrant(@NotNull Coordinator parent, @NotNull Protocol protocol) {
id = new RegistrantIdentifier(Long.toString(nextId++));
this.parent = parent;
this.protocol = protocol;
if (parent.isSubordinate()) {
outstandingRegistrants.put(getIdValue(), this);
registrationCompleted = false;
registrationCompletedGate = new Semaphore(0); // initially closed
} else {
if (registerRequest == null) {
this.setParticpantProtocolService(getLocalParticipantProtocolService());
}
}
}
@NotNull
private String getProtocolIdentifier() {
switch (protocol) {
case COMPLETION:
return COMPLETION.getUri();
case DURABLE:
return DURABLE.getUri();
case VOLATILE:
return VOLATILE.getUri();
default:
return UNKNOWN.getUri();
}
}
public void setParticpantProtocolService(@NotNull final EndpointReference pps) {
if (registerRequest == null) {
registerRequest = new RegisterType();
}
registerRequest.setProtocolIdentifier(this.getProtocolIdentifier());
registerRequest.setParticipantProtocolService((MemberSubmissionEndpointReference) pps);
}
@NotNull
public EndpointReference getParticipantProtocolService() {
return (registerRequest == null) ?
getLocalParticipantProtocolService() :
registerRequest.getParticipantProtocolService();
}
/**
* Get the SOAP register request
*
* @return the SOAP register message
*/
@Nullable
public RegisterType getRegisterRequest() {
return registerRequest;
}
/**
* Get the protocol for this registrant
*
* @return the protocol identifier
*/
@NotNull
public Protocol getProtocol() {
return protocol;
}
/**
* Get the parent coordinator for this Registrant
*
* @return the parent coordinator
*/
@NotNull
public Coordinator getCoordinator() {
return parent;
}
@NotNull
synchronized public EndpointReference getCoordinatorProtocolService() {
return coordinatorProtocolService;
}
/**
* Set the coordinator protocol service received by coor:registerResponse.
*
* @param cps cps epr
*/
public synchronized void setCoordinatorProtocolService(@NotNull final EndpointReference cps) {
coordinatorProtocolService = cps;
setRegistrationCompleted(true);
}
public void register() {
RegistrationManager.getInstance().register(parent, this);
}
@NotNull
public Identifier getId() {
return id;
}
@NotNull
public String getIdValue() {
return id.getValue();
}
// extent of participants
protected static final Map<String, Registrant> outstandingRegistrants = new HashMap<String, Registrant>();
/**
* Lookup outstanding registrant by id
*
* @param id registrant id
* @return the outstanding registrant or null if it doesn't exist
*/
@Nullable
public static Registrant getOutstandingRegistrant(final String id) {
return outstandingRegistrants.get(id);
}
/**
* Remove outstanding registrant by its id.
*
* @param id registrant id
* @return the outstanding registrant or null if it doesn't exist
*/
@Nullable
public static Registrant removeOutstandingRegistrant(final String id) {
return outstandingRegistrants.remove(id);
}
private boolean remoteCPS = false;
public void setRemoteCPS(final boolean value) {
remoteCPS = value;
}
public boolean isRemoteCPS() {
return remoteCPS;
}
public boolean isRegistrationCompleted() {
return registrationCompleted;
}
public synchronized void setRegistrationCompleted(final boolean value) {
registrationCompleted = value;
if (isRemoteCPS()) {
if (logger.isLogging(Level.FINEST)) {
logger.finest(
"setRegistrationCompleted(" + value + ")",
"semaphore has " + registrationCompletedGate.availablePermits() + " permits.");
}
if (value) {
assert (registrationCompletedGate.availablePermits() <= 0);
registrationCompletedGate.release();
if (logger.isLogging(Level.FINEST)) {
logger.finest(
"setRegistrationCompleted(" + value + ")",
"released a permit, semaphore now has " + registrationCompletedGate.availablePermits() + " permits.");
}
}
}
}
/**
* wait for a registerResponse to arrive - this method is only used with remote CPSs
*
* @return true if <RegistrationResponse> was received, false if there was a timeout.
*/
public boolean waitForRegistrationResponse() {
try {
if(logger.isLogging(Level.FINEST)) {
logger.finest("waitForRegistrationResponse", "semaphore should have 0 permits. actual available permits: " + registrationCompletedGate.availablePermits());
assert (registrationCompletedGate.availablePermits() <= 0);
logger.finest("waitForRegistrationResponse", "Waiting for registration response. Calling tryAcquire()...");
}
return !registrationCompletedGate.tryAcquire(1, 40, TimeUnit.SECONDS);
} catch (InterruptedException e) {
e.printStackTrace();
return false;
}
}
abstract public EndpointReference getLocalParticipantProtocolService();
/**
* Forget all resources associated with this Registrant
*/
public abstract void forget();
}
|
