Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
   *
   * Copyright (c) 1997-2013 Oracle and/or its affiliates. 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_1_1.html
  * or packager/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 packager/legal/LICENSE.txt.
  *
  * GPL Classpath Exception:
  * Oracle designates this particular file as subject to the "Classpath"
  * exception as provided by Oracle in the GPL Version 2 section of the License
  * file that accompanied this code.
  *
  * Modifications:
  * If applicable, add the following below the License Header, with the fields
  * enclosed by brackets [] replaced by your own identifying information:
  * "Portions Copyright [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.enterprise.connectors.inbound;
 
 import java.util.List;
 import java.util.Set;
 
Main helper implementation for message-beans associated with a queue. Uses connection consumer for concurrent message delivery.

Author(s):
Qingqing Ouyang
 
 public final class ConnectorMessageBeanClient
         implements MessageBeanClientMessageEndpointFactory {
 
     private static final String MESSAGE_ENDPOINT =
             "javax.resource.spi.endpoint.MessageEndpoint";
     private String activationName;
     
     private ConnectorRegistry registry_;
 
    private final EjbMessageBeanDescriptor descriptor_;
    private final BasicResourceAllocator allocator_;
    private boolean started_ = false;
    private final int CREATED = 0;
    private final int BLOCKED = 1;
    private final int UNBLOCKED = 2;
    private int myState = ;
    private final long WAIT_TIME = 60000;
    private static final String RA_MID="com.sun.enterprise.connectors.inbound.ramid";
    private StringManager localStrings =
                StringManager.getManager(ConnectorMessageBeanClient.class);
    //unique identify a message-driven bean
    private String beanID_//appName:modlueID:beanName
    private static final Logger logger =
            LogDomains.getLogger(ConnectorMessageBeanClient.class.);

    
Creates an instance of ConnectorMessageBeanClient

Parameters:
descriptor EjbMessageBeanDescriptor object.
        this. = descriptor;
         = new BasicResourceAllocator();
        String appName = descriptor.getApplication().getName();
        String moduleID = descriptor.getEjbBundleDescriptor().getModuleID();
        String beanName = descriptor.getName();
         = null;
         = appName + ":" + moduleID + ":" + beanName;
         = ConnectorRegistry.getInstance();
    }

    
Gets executed as part of message bean deployment. Creates the ActivationSpec javabean and does endpointfactory activation with the resource adapter. This code also converts all J2EE 1.3 MDB properties to MQ resource adapter activation spec properties, if user doesnt specifies resource adapter module name in sun-ejb-jar.xml of the MDB. This is done using com.sun.enterprise.connector.system.ActiveJmsResourceAdapter

Parameters:
messageBeanPM MessageBeanProtocolManager object.
    public void setup(MessageBeanProtocolManager messageBeanPMthrows Exception {
         = messageBeanPM;
        String resourceAdapterMid = .getResourceAdapterMid();
        if (resourceAdapterMid == null) {
            resourceAdapterMid = System.getProperty();
        }
        if (resourceAdapterMid == null) {
            String messageListener = .getMessageListenerType();
            //DOL of MDB descriptor has default value as "javax.jms.MessageListener" which
            //will take care of the case when the message-listener-type is not specified in the DD
            if(..equals(messageListener)){
                resourceAdapterMid = .;
                .fine("No ra-mid is specified, using default JMS Resource Adapter for message-listener-type " +
                        "["+.getMessageListenerType()+"]");
            }else{
                List<StringresourceAdapters =
                        ConnectorRegistry.getInstance().getConnectorsSupportingMessageListener(messageListener);
                if(resourceAdapters.size() == 1){
                    resourceAdapterMid = resourceAdapters.get(0);
                    String message = .getString("msg-bean-client.defaulting.message-listener.supporting.rar",
                            resourceAdapterMidmessageListener);
                    .info(message);
                }else if(resourceAdapters.size()<=0){
                    String message = .getString("msg-bean-client.could-not-detect-ra-mid",
                            .getMessageListenerType() );
                    throw new ConnectorRuntimeException(message);
                }else{
                    String message = .getString("msg-bean-client.multiple-ras-supporting-message-listener",
                            messageListener);
                    throw new ConnectorRuntimeException(message);
                }
            }
        }
        ActiveInboundResourceAdapter aira = getActiveResourceAdapter(resourceAdapterMid);
        aira.updateMDBRuntimeInfo(,
                                       .getPoolDescriptor());
        //the resource adapter this MDB client is deployed to
        ResourceAdapter ra = aira.getResourceAdapter();
        if(ra == null){
            String i18nMsg = .getString("msg-bean-client.ra.class.not.specified"resourceAdapterMid);
            throw new ConnectorRuntimeException(i18nMsg);
        }
        ConnectorDescriptor desc = aira.getDescriptor();
        MessageListener msgListener = getMessageListener(desc);
        String activationSpecClassName = null;
        if (msgListener != null) {
            activationSpecClassName = msgListener.getActivationSpecClass();
        }
        if (activationSpecClassName != null) {
            if (.isLoggable(.)) {
                String msg = "ActivationSpecClassName = " + activationSpecClassName;
                .log(.msg);
            }
            try {
                ActivationSpec activationSpec = getActivationSpec(airaactivationSpecClassName);
                activationSpec.setResourceAdapter(ra);
                //at this stage, activation-spec is created, config properties merged with ejb-descriptor.
                //validate activation-spec now
                ConnectorRuntime runtime = ConnectorRuntime.getRuntime();
                runtime.getConnectorBeanValidator().validateJavaBean(activationSpecresourceAdapterMid);
                aira.validateActivationSpec(activationSpec);
                 = ;
                ra.endpointActivation(thisactivationSpec);
                aira.addEndpointFactoryInfo(,
                        new MessageEndpointFactoryInfo(thisactivationSpec));
            } catch (Exception ex) {
                Object args[] = new Object[]{resourceAdapterMidactivationSpecClassNameex};
                .log(."endpoint.activation.failure"args);
                throw (Exception) (new Exception()).initCause(ex);
            }
        } else {
            //FIXME  throw some exception here.
            throw new Exception("Unsupported message listener type");
        }
    }
    private ActivationSpec getActivationSpec(ActiveInboundResourceAdapter airaString activationSpecClassName)
            throws Exception {
        ClassLoader cl = aira.getClassLoader();
        Class aClass = cl.loadClass(activationSpecClassName);
        if (.isLoggable(.)) {
            .log(."classloader = "
                    + aClass.getClassLoader());
            .log(."classloader parent = "
                    + aClass.getClassLoader().getParent());
        }
        ActivationSpec activationSpec =
                (ActivationSpecaClass.newInstance();
        Set props = ConnectorsUtil.getMergedActivationConfigProperties(getDescriptor());
        AccessController.doPrivileged(new SetMethodAction(activationSpecprops));
        return activationSpec;
    }
        String msgListenerType = getDescriptor().getMessageListenerType();
        if (msgListenerType == null || "".equals(msgListenerType))
            msgListenerType = "javax.jms.MessageListener";
        Iterator i =
                desc.getInboundResourceAdapter().getMessageListeners().iterator();
        MessageListener msgListener = null;
        while (i.hasNext()) {
            msgListener = (MessageListeneri.next();
            if (msgListenerType.equals(msgListener.getMessageListenerType()))
                break;
        }
        return msgListener;
    }
    private ActiveInboundResourceAdapter getActiveResourceAdapter(String resourceAdapterMidthrows Exception {
        Object activeRar = .getActiveResourceAdapter(resourceAdapterMid);
        // Except system-rars, all other rars are loaded eagerly.
        // Check whether the rar is a system-rar.
        // (as of now, jms-ra is the only inbound system-rar)  
        if (activeRar == null && ConnectorsUtil.belongsToSystemRA(resourceAdapterMid)) {
            ConnectorRuntime crt = ConnectorRuntime.getRuntime();
            crt.loadDeferredResourceAdapter(resourceAdapterMid);
            activeRar = .getActiveResourceAdapter(resourceAdapterMid);
        }
        if (activeRar == null) {
            String msg = "Resource adapter " + resourceAdapterMid + " is not deployed";
            throw new ConnectorRuntimeException(msg);
        }
        if (!(activeRar instanceof ActiveInboundResourceAdapter)) {
            throw new Exception("Resource Adapter selected doesn't support Inbound");
        }
        return (ActiveInboundResourceAdapteractiveRar;
    }

    
Marks the completion of MDB deployment. Unblocks the createEndPoint method call.

    public void start() throws Exception {
        .logp(.,
                "ConnectorMessageBeanClient""start""called...");
         = true;
        synchronized (this) {
             = ;
            notifyAll();
        }
    }

    
Does endpoint deactivation with the resource adapter. Also remove sthe MessageEndpointFactoryInfo from house keeping.
    public void close() {
        .logp(.,
                "ConnectorMessageBeanClient""close""called...");
         = false//no longer available
        String resourceAdapterMid = getDescriptor().getResourceAdapterMid();
        ActiveResourceAdapter activeRar =
                .getActiveResourceAdapter(resourceAdapterMid);
        if (activeRar instanceof ActiveInboundResourceAdapter) { //in case the RA is already undeployed
            ActiveInboundResourceAdapter rar = (ActiveInboundResourceAdapteractiveRar;
            MessageEndpointFactoryInfo info = rar.getEndpointFactoryInfo();
            if (info != null) {
                rar.getResourceAdapter().endpointDeactivation(
                        info.getEndpointFactory(), info.getActivationSpec());
                rar.removeEndpointFactoryInfo();
            } else {
                .log(."Not de-activating the end point, since it is not activated");
            }
        }
    }
        return ;
    }

    
Creates a MessageEndpoint. This method gets blocked either until start() is called or until one minute. This is the time for completion of MDB deployment.

Internally this method creates a message bean listener from the MDB container and a proxy object fo delivering messages.

Returns:
MessageEndpoint object.
Throws:
UnavailableException In case of any failure. This should change.
    public MessageEndpoint
        // This is a temporary workaround for blocking the the create enpoint
        // until the deployment completes.  One thread would wait for maximum a
        // a minute.
        return createEndpoint(xa);
    }

    
Checks whether the message delivery is transacted for the method.

Returns:
true or false.
    public boolean isDeliveryTransacted(Method method) {
        return .isDeliveryTransacted(method);
    }

    

Returns:
beanID of the message bean client
    public String toString() {
        return ;
    }

    
    public MessageEndpoint createEndpoint(XAResource xaResourcelong timeoutthrows UnavailableException {
        synchronized (this) {
            while ( == ) {
                try {
                    wait(timeout);
                } catch (Exception e) {
                    // This exception should not affect the functionality.
                } finally {
                    // Once the first thread comes out of wait, block is
                    // is removed. This makes sure that the time for which the
                    // the block remains is limited. Max 2x6000.
                     = ;
                }
            }
        }
        if (!) {
            .log(."endpointfactory.unavailable");
            throw new UnavailableException(
                    "EndpointFactory is currently not available");
        }
        MessageEndpoint endpoint = null;
        try {
            ResourceHandle resourceHandle = .createResource(xaResource);
            MessageBeanListener listener =
                    .createMessageBeanListener(resourceHandle);
            //Use the MDB's application classloader to load the
            //message listener class.  If it is generic listener
            //class, it is expected to be packaged with the MDB application
            //or in the system classpath.
            String moduleID = getDescriptor().getApplication().getModuleID();
            Class endpointClass = null;
            ClassLoader loader = null;
            try {
                BundleDescriptor moduleDesc =
                        getDescriptor().getEjbBundleDescriptor();
                loader = moduleDesc.getClassLoader();
            } catch (Exception e) {
                .log(."endpointfactory.loader_not_found"e);
            }
            if (loader == null) {
                loader = Thread.currentThread().getContextClassLoader();
            }
            endpointClass = loader.loadClass();
            String msgListenerType = getDescriptor().getMessageListenerType();
            if (msgListenerType == null || "".equals(msgListenerType))
                msgListenerType = "javax.jms.MessageListener";
            Class listenerClass = loader.loadClass(msgListenerType);
            MessageEndpointInvocationHandler handler =
                    new MessageEndpointInvocationHandler(listener);
            endpoint = (MessageEndpoint) Proxy.newProxyInstance
                    (loadernew Class[]{endpointClasslistenerClass}, handler);
        } catch (Exception ex) {
            throw (UnavailableException)
                    (new UnavailableException()).initCause(ex);
        }
        return endpoint;
    }
    
    

Override:
    public String getActivationName(){
      if( == null){
        
        String appName = .getApplication().getName();
        String moduleID = .getEjbBundleDescriptor().getModuleID();
        int pound = moduleID.indexOf("#");
        if(pound>=0){
            // the module ID is in the format: appName#ejbName.jar
            // remove the appName part since it is duplicated
            moduleID = moduleID.substring(pound+1);
        }
        String mdbClassName = .getEjbClassName();
        ServerEnvironmentImpl env = Globals.get(ServerEnvironmentImpl.class);
        String instanceName = env.getInstanceName();
        
        Domain domain = Globals.get(Domain.class);
        String domainName = domain.getName();
        Cluster cluster = domain.getServerNamed(instanceName).getCluster();
        String clusterName=null;
        if(cluster!=null){
          // this application is deployed in a cluster
          clusterName = cluster.getName();
        }
        
         = computeActivationName(domainNameclusterNameinstanceNameappNamemoduleIDmdbClassName);
      }
      return ;
    }

    
Compute the activation name according to the names of domain, cluster, instance, application, module and MDB. Check whether the combination of the activation name and instance name is longer than 128 characters. If yes, then compact the activation name.
    public String computeActivationName(String domainNameString clusterName
            String instanceNameString appNameString moduleIDString mdbName){
        
        if(clusterName!=null){
            // this application is deployed in a cluster
            String fullActivationName = combineString(domainNameclusterNameappNamemoduleIDmdbName);
            // Check if the combination of activation name and instance name is longer
            // than 128 characters. If yes, then compact it.
            // BootstrapContextImpl.getInstanceName() will return at most 24 characters
            int instanceLenth = Math.min(instanceName.length(), .);
            if((fullActivationName.length()+instanceLenth)>127){
                String compactedName = compactActivationName(fullActivationNamedomainName
                        clusterNameinstanceNameappNamemoduleIDmdbName);
                .log(."The original activation is: "+fullActivationName
                        +", because it is too long, compact it to: "+compactedName);
                return compactedName;
            }else{
                return fullActivationName;
            }
        }else{
            // this application is deployed in a stand-alone server instance.
            String fullActivationName = combineString(domainNameinstanceNameappNamemoduleIDmdbName);
            if(fullActivationName.length()>128){
                String compactedName = compactActivationName(fullActivationNamedomainName
                        instanceNameappNamemoduleIDmdbName);
                .log(."The original activation is: "+fullActivationName
                        +", because it is too long, compact it to: "+compactedName);
                return compactedName;
            }else{
                return fullActivationName;
            }
        }
    }
    /* 
     * This method is called when the server is a clustered instance.
     * 
     * Compact the activationName so that the combination of it and instance name
     * is no longer than 128 characters. The combination of activation name and
     * instance name is of the format:
     *   domain_cluster_application_module_mdb_MD5_instance
     * 
     * The basic idea is that: 
     *   1. Add the MD5 digest of the original activationName. This can ensure the 
     *      (almost) uniqueness of the activation name. The new activation name
     *      will be of the format: domain_cluster_application_module_mdb_MD5 
     *   2. The instance name is no longer than 24 characters, the method 
     *      BootstrapContextImpl.getInstanceName() will truncate instance name 
     *      if need.
     *   3. Truncate the longest element among the domain, instance, application,
     *      module and mdb names, until the combination of new activation 
     *      name and instance name is no longer than 128 characters.
     *      
     */ 
    private String compactActivationName(String originalActivationName
            String domainNameString clusterNameString instanceName
            String appNameString moduleIDString mdbName){
        String[] names = new String[5];
        names[0] = domainName;
        names[1] = clusterName;
        names[2] = appName;
        names[3] = moduleID;
        names[4] = mdbName;
        
        // the instanceName is longer than 24 characters.
        int instanceLenth = Math.min(instanceName.length(), .);
        // the MD5 digestion has 32 characters, the remaining capacity 
        // is 128-(32 + size_of_instanceName + 2).
        int maxTotal = 94 - instanceLenth;
        StringBuilder compacted = compactString(namesmaxTotal);
        String digest = computeMD5(originalActivationName);
        compacted.append("_").append(digest);
        return compacted.toString();
    }
    /* 
     * This method is called when the server is a stand-alone instance.
     * 
     * Compact the activationName so that it is no longer than 128 characters.
     * The new activation name is of the format:
     *   domain_instance_application_module_mdb_MD5
     * 
     * The basic idea is that: 
     *   1. Add the MD5 digest of the original activationName which can ensure the 
     *      (almost) uniqueness of the activation. 
     *   2. Truncate the longest element among the domain, instance, application,
     *      module and mdb names, until the combination of them and MD5 
     *      digestion is no longer than 128 characters.
     *      
     */ 
    private String compactActivationName(String originalActivationNameString domainName
            String instanceNameString appNameString moduleIDString mdbName){
        String[] names = new String[5];
        names[0] = domainName;
        names[1] = instanceName;
        names[2] = appName;
        names[3] = moduleID;
        names[4] = mdbName;
        // the MD5 digestion has 32 characters, the remaining capacity is 
        // (128-32-1) = 95 characters. 
        StringBuilder compacted = compactString(names, 95);
        String digest = computeMD5(originalActivationName);
        compacted.append("_").append(digest);
        return compacted.toString();
    }
    
    /* 
     * Compact the given Strings so that their total size is no longer than
     * maxTotal characters. 
     *  
     * Find the longest string, truncate its first half part, because in the most 
     * cases, the last characters are more significant. Do this operation until 
     * the total size is no longer than maxTotal:
     * 
     */ 
    private StringBuilder compactString(String[] textsint maxTotal){
        int arrayLengh = texts.length;
        int total=0;
        for(int i=0; i<arrayLenghi++ ){
            total+=texts[i].length();
        }
        // add the size of delimiter characters between the strings
        total+=arrayLengh-1;
        
        while(total>maxTotal){
            // find the longest item
            int longestLength = 0;
            int longestIndex = 0;
            for(int i=0; i<arrayLenghi++ ){
                if(texts[i].length()>longestLength){
                    longestLength = texts[i].length();
                    longestIndex=i;
                }
            }
            // truncate the first half part of the string
            // because it seems that the last characters are more significant. 
            int trunctionSize= Math.min(longestLength>>1, total-maxTotal);
            texts[longestIndex]=texts[longestIndex].substring(trunctionSizelongestLength);
            // re-compute the total size
            total -= trunctionSize;
        }
        StringBuilder sb = new StringBuilder(128);
        sb.append(texts[0]);
        for(int i=1; i<arrayLenghi++ ){
            sb.append("_").append(texts[i]);
        }
        return sb;
    }
    
    private String combineString(String... names) {
        StringBuilder sb = new StringBuilder(128);
        sb.append(names[0]);
        for(int i=1; i<names.lengthi++){
            sb.append("_").append(names[i]);
        }
        return sb.toString();
    }
    private String computeMD5(String message){
        StringBuilder sb = new StringBuilder(32);
        try {
            MessageDigest md5 = MessageDigest.getInstance("MD5");
            md5.update(message.getBytes());
            byte[] digest = md5.digest();
            for(int i=0; i<digest.lengthi++){
                sb.append(Integer.toHexString((digest[i]>>4)&0x0F));
                sb.append(Integer.toHexString(digest[i]&0x0F));
            }
            
        } catch (NoSuchAlgorithmException ignore) {
            ignore.printStackTrace();
        }
        return sb.toString();
    }
New to GrepCode? Check out our FAQ X