org.apache.openejb.jee.Interceptor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openejb-jee Show documentation
The newest version!
/**
 *
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */

package org.apache.openejb.jee;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlID;
import javax.xml.bind.annotation.XmlType;
import javax.xml.bind.annotation.adapters.CollapsedStringAdapter;
import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
import java.util.ArrayList;
import java.util.List;
import java.util.Collection;
import java.util.Map;


/**
 * The interceptorType element declares information about a single
 * interceptor class.  It consists of :
 * 
 * - An optional description.
 * - The fully-qualified name of the interceptor class.
 * - An optional list of around invoke methods declared on the
 * interceptor class and/or its super-classes.
 * - An optional list environment dependencies for the interceptor
 * class and/or its super-classes.
 * - An optional list of post-activate methods declared on the
 * interceptor class and/or its super-classes.
 * - An optional list of pre-passivate methods declared on the
 * interceptor class and/or its super-classes.
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "interceptorType", propOrder = {
        "description",
        "interceptorClass",
        "aroundInvoke",
        "envEntry",
        "ejbRef",
        "ejbLocalRef",
        "serviceRef",
        "resourceRef",
        "resourceEnvRef",
        "messageDestinationRef",
        "persistenceContextRef",
        "persistenceUnitRef",
        "postConstruct",
        "preDestroy",
        "postActivate",
        "prePassivate"
        })
public class Interceptor implements JndiConsumer, Session {

    @XmlElement(required = true)
    protected List description;
    @XmlElement(name = "interceptor-class", required = true)
    protected String interceptorClass;
    @XmlElement(name = "around-invoke", required = true)
    protected List aroundInvoke;
    @XmlElement(name = "env-entry", required = true)
    protected KeyedCollection envEntry;
    @XmlElement(name = "ejb-ref", required = true)
    protected KeyedCollection ejbRef;
    @XmlElement(name = "ejb-local-ref", required = true)
    protected KeyedCollection ejbLocalRef;
    @XmlElement(name = "service-ref", required = true)
    protected KeyedCollection serviceRef;
    @XmlElement(name = "resource-ref", required = true)
    protected KeyedCollection resourceRef;
    @XmlElement(name = "resource-env-ref", required = true)
    protected KeyedCollection resourceEnvRef;
    @XmlElement(name = "message-destination-ref", required = true)
    protected KeyedCollection messageDestinationRef;
    @XmlElement(name = "persistence-context-ref", required = true)
    protected KeyedCollection persistenceContextRef;
    @XmlElement(name = "persistence-unit-ref", required = true)
    protected KeyedCollection persistenceUnitRef;
    @XmlElement(name = "post-construct", required = true)
    protected List postConstruct;
    @XmlElement(name = "pre-destroy", required = true)
    protected List preDestroy;
    @XmlElement(name = "post-activate", required = true)
    protected List postActivate;
    @XmlElement(name = "pre-passivate", required = true)
    protected List prePassivate;
    @XmlAttribute
    @XmlJavaTypeAdapter(CollapsedStringAdapter.class)
    @XmlID
    protected String id;

    public Interceptor() {
    }

    public Interceptor(Class interceptorClass) {
        this.interceptorClass = interceptorClass.getName();
    }

    public Interceptor(String interceptorClass) {
        this.interceptorClass = interceptorClass;
    }

    public String getJndiConsumerName() {
        if (interceptorClass == null) {
            return null;
        }
        return interceptorClass.replaceAll(".*\\.","");
    }

    public List getDescription() {
        if (description == null) {
            description = new ArrayList();
        }
        return this.description;
    }

    public String getInterceptorClass() {
        return interceptorClass;
    }

    public void setInterceptorClass(String value) {
        this.interceptorClass = value;
    }

    public List getAroundInvoke() {
        if (aroundInvoke == null) {
            aroundInvoke = new ArrayList();
        }
        return this.aroundInvoke;
    }

    public void addAroundInvoke(String method){
        assert interceptorClass != null: "Set the interceptorClass before calling this method";
        getAroundInvoke().add(new AroundInvoke(interceptorClass, method));
    }

    public Collection getEnvEntry() {
        if (envEntry == null) {
            envEntry = new KeyedCollection();
        }
        return this.envEntry;
    }

    public Map getEnvEntryMap() {
        if (envEntry == null) {
            envEntry = new KeyedCollection();
        }
        return this.envEntry.toMap();
    }

    public Collection getEjbRef() {
        if (ejbRef == null) {
            ejbRef = new KeyedCollection();
        }
        return this.ejbRef;
    }

    public Map getEjbRefMap() {
        if (ejbRef == null) {
            ejbRef = new KeyedCollection();
        }
        return this.ejbRef.toMap();
    }

    public Collection getEjbLocalRef() {
        if (ejbLocalRef == null) {
            ejbLocalRef = new KeyedCollection();
        }
        return this.ejbLocalRef;
    }

    public Map getEjbLocalRefMap() {
        if (ejbLocalRef == null) {
            ejbLocalRef = new KeyedCollection();
        }
        return this.ejbLocalRef.toMap();
    }

    public Collection getServiceRef() {
        if (serviceRef == null) {
            serviceRef = new KeyedCollection();
        }
        return this.serviceRef;
    }

    public Map getServiceRefMap() {
        if (serviceRef == null) {
            serviceRef = new KeyedCollection();
        }
        return this.serviceRef.toMap();
    }

    public Collection getResourceRef() {
        if (resourceRef == null) {
            resourceRef = new KeyedCollection();
        }
        return this.resourceRef;
    }

    public Map getResourceRefMap() {
        if (resourceRef == null) {
            resourceRef = new KeyedCollection();
        }
        return this.resourceRef.toMap();
    }

    public Collection getResourceEnvRef() {
        if (resourceEnvRef == null) {
            resourceEnvRef = new KeyedCollection();
        }
        return this.resourceEnvRef;
    }

    public Map getResourceEnvRefMap() {
        if (resourceEnvRef == null) {
            resourceEnvRef = new KeyedCollection();
        }
        return this.resourceEnvRef.toMap();
    }

    public Collection getMessageDestinationRef() {
        if (messageDestinationRef == null) {
            messageDestinationRef = new KeyedCollection();
        }
        return this.messageDestinationRef;
    }

    public Map getMessageDestinationRefMap() {
        if (messageDestinationRef == null) {
            messageDestinationRef = new KeyedCollection();
        }
        return this.messageDestinationRef.toMap();
    }

    public Collection getPersistenceContextRef() {
        if (persistenceContextRef == null) {
            persistenceContextRef = new KeyedCollection();
        }
        return this.persistenceContextRef;
    }

    public Map getPersistenceContextRefMap() {
        if (persistenceContextRef == null) {
            persistenceContextRef = new KeyedCollection();
        }
        return this.persistenceContextRef.toMap();
    }

    public Collection getPersistenceUnitRef() {
        if (persistenceUnitRef == null) {
            persistenceUnitRef = new KeyedCollection();
        }
        return this.persistenceUnitRef;
    }

    public Map getPersistenceUnitRefMap() {
        if (persistenceUnitRef == null) {
            persistenceUnitRef = new KeyedCollection();
        }
        return this.persistenceUnitRef.toMap();
    }

    public List getPostConstruct() {
        if (postConstruct == null) {
            postConstruct = new ArrayList();
        }
        return this.postConstruct;
    }

    public void addPostConstruct(String method){
        assert interceptorClass != null: "Set the interceptorClass before calling this method";
        getPostConstruct().add(new LifecycleCallback(interceptorClass, method));
    }

    public List getPreDestroy() {
        if (preDestroy == null) {
            preDestroy = new ArrayList();
        }
        return this.preDestroy;
    }

    public void addPreDestroy(String method){
        assert interceptorClass != null: "Set the interceptorClass before calling this method";
        getPreDestroy().add(new LifecycleCallback(interceptorClass, method));
    }

    public List getPostActivate() {
        if (postActivate == null) {
            postActivate = new ArrayList();
        }
        return this.postActivate;
    }

    public void addPostActivate(String method){
        assert interceptorClass != null: "Set the interceptorClass before calling this method";
        getPostActivate().add(new LifecycleCallback(interceptorClass, method));
    }

    public List getPrePassivate() {
        if (prePassivate == null) {
            prePassivate = new ArrayList();
        }
        return this.prePassivate;
    }

    public void addPrePassivate(String method){
        assert interceptorClass != null: "Set the interceptorClass before calling this method";
        getPrePassivate().add(new LifecycleCallback(interceptorClass, method));
    }

    public List getInitMethod() {
        return new ArrayList();
    }

    public List getRemoveMethod() {
        return new ArrayList();
    }

    public String getId() {
        return id;
    }

    public void setId(String value) {
        this.id = value;
    }

}