/*
* 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.common;
import com.sun.xml.ws.api.WSBinding;
import com.sun.xml.ws.api.model.JavaMethod;
import com.sun.xml.ws.api.model.SEIModel;
import com.sun.xml.ws.api.model.wsdl.WSDLBoundOperation;
import com.sun.xml.ws.api.model.wsdl.WSDLPort;
import com.sun.xml.ws.policy.AssertionSet;
import com.sun.xml.ws.policy.Policy;
import com.sun.xml.ws.policy.PolicyAssertion;
import com.sun.xml.ws.policy.PolicyException;
import com.sun.xml.ws.policy.PolicyMap;
import com.sun.xml.ws.policy.PolicyMapExtender;
import com.sun.xml.ws.policy.PolicyMapKey;
import com.sun.xml.ws.policy.PolicySubject;
import com.sun.xml.ws.policy.jaxws.spi.PolicyMapUpdateProvider;
import com.sun.xml.ws.policy.sourcemodel.AssertionData;
import static com.sun.xml.ws.tx.common.Constants.AT_ALWAYS_CAPABILITY;
import static com.sun.xml.ws.tx.common.Constants.AT_ASSERTION;
import static com.sun.xml.ws.tx.common.Constants.WSP2002_OPTIONAL;
import com.sun.xml.ws.tx.common.TransactionAnnotationProcessor.TransactionAttributeType;
import javax.xml.namespace.QName;
import java.util.ArrayList;
import java.util.Collection;
import java.util.logging.Level;
/**
* From CMT EJB methods generate wsdl:binding/wsdl:operations with semantically equivalent WS-AT Policy Assertion(s).
* <p/>
* Known limitation: not accounting for ejb deployment descriptor, only working off of TransactionAttribute annotations.
*/
public class TxMapUpdateProvider implements PolicyMapUpdateProvider {
final static private TxLogger logger = TxLogger.getATLogger(TxMapUpdateProvider.class);
static private boolean nonJavaEEContainer = false;
/**
* Update policy map with operation scope of correct ws-at policy assertions.
* <p/>
* Only looking for this for java to wsdl at tool time.
*
* @param policyMapMutator
* @param policyMap
* @param model
* @param wsBinding
*/
public void update(final PolicyMapExtender policyMapMutator, final PolicyMap policyMap,
final SEIModel model, final WSBinding wsBinding) throws PolicyException {
final String METHOD_NAME = "update";
if (nonJavaEEContainer) {
return;
}
// For each method of a CMT EJB, map its effective javax.ejb.TransactionAttribute to semantically equivalent
// ws-at policy assertion.
if (model != null) {
final Collection<? extends JavaMethod> methods = model.getJavaMethods();
Class CMTEJB = null;
TransactionAttributeType classDefaultTxnAttr = null;
for (JavaMethod method : methods) {
if (CMTEJB == null) {
boolean isCMTEJB = false;
final Class theClass = method.getSEIMethod().getDeclaringClass();
try {
isCMTEJB = TransactionAnnotationProcessor.isContainerManagedEJB(theClass);
} catch (NoClassDefFoundError e) {
// running in a container that does not support EJBs; terminate processing of EJB annotations
nonJavaEEContainer = true;
logger.info(METHOD_NAME, LocalizationMessages.NON_EE_CONTAINER_2005(e.getLocalizedMessage()));
return;
}
if (isCMTEJB) {
// perform class level caching of info
CMTEJB = theClass;
classDefaultTxnAttr = TransactionAnnotationProcessor.getTransactionAttributeDefault(theClass);
} else {
// not a CMT EJB, no transaction attributes to look for; just return
return;
}
}
// we have a CMT EJB. Map its transaction attribute to proper ws-at policy assertion.
final TransactionAttributeType txnAttr =
TransactionAnnotationProcessor.getEffectiveTransactionAttribute(method.getSEIMethod(), classDefaultTxnAttr);
final String policyId = model.getBoundPortTypeName().getLocalPart() + "_" + method.getOperationName() + "_WSAT_Policy";
final Policy policy = mapTransactionAttribute2WSATPolicy(policyId, txnAttr);
if (policy != null) {
// insert ws-at policy assertion in operation scope into policyMapMutator
final PolicyMapKey operationKey =
PolicyMap.createWsdlOperationScopeKey(model.getServiceQName(),
model.getPortName(), new QName(model.getTargetNamespace(), method.getOperationName()));
final PolicySubject generatedWsatPolicySubject = new PolicySubject(method, policy);
if (logger.isLogging(Level.FINE)) {
logger.fine(METHOD_NAME,
LocalizationMessages.ADD_AT_POLICY_ASSERTION_2007(
model.getPortName().toString(),
method.getOperationName(),
policy.toString(),
txnAttr.toString(),
CMTEJB.getName(),
method.getMethod().getName()));
} else {
logger.info(METHOD_NAME,
LocalizationMessages.ADD_AT_POLICY_ASSERTION_2007(
model.getPortName().toString(),
method.getOperationName(),
policy.getId(),
txnAttr.toString(),
CMTEJB.getName(),
method.getMethod().getName()));
}
policyMapMutator.putOperationSubject(operationKey, generatedWsatPolicySubject);
}
} // for each method in CMT EJB
}
}
static class WsatPolicyAssertion extends PolicyAssertion {
static private AssertionData createAssertionData(final QName assertionQName, final boolean isOptional) {
final AssertionData result = AssertionData.createAssertionData(assertionQName);
result.setOptionalAttribute(isOptional);
if (isOptional) {
// patch for wsit 419
result.setAttribute(WSP2002_OPTIONAL, "true");
}
return result;
}
WsatPolicyAssertion(final QName wsatPolicyAssertionName, final boolean isOptional) {
super(createAssertionData(wsatPolicyAssertionName, isOptional), null, null);
}
}
static final private WsatPolicyAssertion AT_ASSERTION_OPTIONAL = new WsatPolicyAssertion(AT_ASSERTION, true);
static final private WsatPolicyAssertion AT_ASSERTION_REQUIRED = new WsatPolicyAssertion(AT_ASSERTION, false);
static final private WsatPolicyAssertion AT_ALWAYS_CAPABILITY_PA = new WsatPolicyAssertion(AT_ALWAYS_CAPABILITY, false);
/**
* Pass in what the effective transaction attribute for a given Container Manager Transaction EJB method and return the
* semantically closest WS-AT policy assertion.
* <p/>
* This is best match between Java EE Transaction Attribute and WS-AT Policy Assertion.
* There are a number of differences between them.
*/
private Policy mapTransactionAttribute2WSATPolicy(final String id, final TransactionAttributeType txnAttr) {
switch (txnAttr) {
case NOT_SUPPORTED:
case NEVER: // ws-at does not require exception thrown if txn propagated with no assertion.
// no ws-at policy assertion on wsdl:binding/wsdl:operation is equivalent of no
// claim.
return null;
case MANDATORY:
return createATPolicy(id, AT_ASSERTION_REQUIRED);
case SUPPORTS:
return createATPolicy(id, AT_ASSERTION_OPTIONAL);
case REQUIRES_NEW:
return createATPolicy(id, AT_ALWAYS_CAPABILITY_PA);
case REQUIRED:
return createATPolicy(id, AT_ASSERTION_OPTIONAL, AT_ALWAYS_CAPABILITY_PA);
default:
return null;
}
}
static private Policy createATPolicy(final String id, final WsatPolicyAssertion atpa) {
return createATPolicy(id, atpa, null);
}
static private Policy createATPolicy(final String id, final WsatPolicyAssertion pa1, final WsatPolicyAssertion pa2) {
final ArrayList<AssertionSet> assertionSets = new ArrayList<AssertionSet>(1);
final int numAssertions = (pa2 == null ? 1 : 2);
final ArrayList<PolicyAssertion> assertions = new ArrayList<PolicyAssertion>(numAssertions);
assertions.add(pa1);
if (pa2 != null) {
assertions.add(pa2);
}
assertionSets.add(AssertionSet.createAssertionSet(assertions));
return Policy.createPolicy(null, id, assertionSets);
}
}
|
