/*
* 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.enterprise.deployment;
import com.sun.enterprise.deployment.types.EjbReference;
import com.sun.enterprise.util.LocalStringManagerImpl;
/**
* An object representing a link to another ejb.
*
* @author Jerome Dochez
*
*/
public class EjbReferenceDescriptor extends EnvironmentProperty implements com.sun.enterprise.deployment.types.EjbReference, NamedDescriptor {
// In case the reference has been resolved, the ejbDescriptor will
// be the referenced ejb.
private EjbDescriptor ejbDescriptor;
private static LocalStringManagerImpl localStrings =
new LocalStringManagerImpl(EjbReferenceDescriptor.class);
// We need the referring bundle for what ?
private BundleDescriptor referringBundle;
// bean type and interfaces names
private String refType=null;
private String refHomeIntf=null;
private String refIntf=null;
// local-ref or remote-ref
private boolean isLocal=false;
/**
* holds the ejb-link value associated to this ejb reference before the
* ejbs were resolved
*/
private String ejbLink=null;
/**
* copy constructor
*
* @param other handle to other EjbReferenceDescriptor to clone
*/
public EjbReferenceDescriptor(EjbReferenceDescriptor other) {
super(other);
isLocal = other.isLocal; // boolean
refType = other.refType; // String
refHomeIntf = other.refHomeIntf; // String
refIntf = other.refIntf; // String
ejbLink = other.ejbLink; // String
referringBundle = other.referringBundle; // copy as-is
ejbDescriptor = other.ejbDescriptor;
if (ejbDescriptor != null) {
ejbDescriptor.addEjbReferencer(this); // ???
}
}
/**
* Construct an remote ejb reference to the given ejb descriptor
* with the given name and descriptor of the reference.
*
* @param name the ejb-ref name as used in the referencing bean
* @param optional description
* @param ejbDescriptor of the referenced bean
*/
public EjbReferenceDescriptor(String name, String description, EjbDescriptor ejbDescriptor) {
super(name, "", description);
this.setEjbDescriptor(ejbDescriptor);
}
/**
* constructs an local or remote ejb reference to the given ejb descriptor,
* the desciption and the name of the reference
*
* @param name is the name of the reference
* @param description is a human readable description of the reference
* @param ejbDescriptor the referenced EJB
* @param isLocal true if the reference uses the local interfaces
*/
public EjbReferenceDescriptor(String name, String description, EjbDescriptor ejbDescriptor, boolean isLocal) {
super(name, "", description);
this.isLocal = isLocal;
this.setEjbDescriptor(ejbDescriptor);
}
/**
* Constructs a reference in the extrernal state.
*/
public EjbReferenceDescriptor() {
}
/**
* Set the referring bundle, i.e. the bundle within which this
* EJB reference is declared.
*/
public void setReferringBundleDescriptor(BundleDescriptor referringBundle)
{
this.referringBundle = referringBundle;
}
/**
* Get the referring bundle, i.e. the bundle within which this
* EJB reference is declared.
*/
public BundleDescriptor getReferringBundleDescriptor()
{
return referringBundle;
}
/**
* Sets the ejb descriptor to which I refer.
* @param the ejb descriptor referenced, null if it is unknow at this time
*/
public void setEjbDescriptor(EjbDescriptor ejbDescriptor) {
if (this.ejbDescriptor != null) {
this.ejbDescriptor.removeEjbReferencer(this); // remove previous referencer
}
this.ejbDescriptor=ejbDescriptor;
if (ejbDescriptor!=null) {
ejbDescriptor.addEjbReferencer(this);
if (isLocal()) {
if (!ejbDescriptor.isLocalInterfacesSupported() &&
!ejbDescriptor.isLocalBusinessInterfacesSupported()) {
throw new RuntimeException(localStrings.getLocalString(
"entreprise.deployment.invalidLocalInterfaceReference",
"Trying to set an ejb-local-ref on an EJB while the EJB does not define local interfaces"));
}
} else {
if (!ejbDescriptor.isRemoteInterfacesSupported() &&
!ejbDescriptor.isRemoteBusinessInterfacesSupported()) {
throw new RuntimeException(localStrings.getLocalString(
"entreprise.deployment.invalidRemoteInterfaceReference",
"Trying to set an ejb-ref on an EJB, while the EJB does not define remote interfaces"));
}
}
}
}
/**
* Sets the jndi name of the bean tyo whoch I am referring.*/
public void setJndiName(String jndiName) {
this.setValue(jndiName);
}
/** return true if I know the name of the ejb to which I refer.
*/
public boolean isLinked() {
return ejbLink!=null;
}
/**
* @return the name of the ejb to which I refer
*/
public String getLinkName() {
if (ejbDescriptor==null) {
return ejbLink;
} else {
if (ejbLink != null && ejbLink.length()!=0) {
return ejbLink;
}
return ejbDescriptor.getName();
}
}
/**
* Sets the name of the ejb to which I refer.
*/
public void setLinkName(String linkName) {
ejbLink = linkName;
}
/**
* return the jndi name of the bean to which I refer.
*/
public String getJndiName() {
String jndiName = this.getValue();
if( isLocal() ) {
// mapped-name has no meaning for the local ejb view. ejb-link
// should be used to resolve any ambiguities about the target
// local ejb.
return jndiName;
} else {
return (jndiName != null && ! jndiName.equals("")) ?
jndiName : getMappedName();
}
}
/**
* Return the jndi name of the bean to which I refer.
*/
public String getValue() {
if (ejbDescriptor == null) {
return super.getValue();
} else {
if (isLocal()) {
return super.getValue();
} else {
return ejbDescriptor.getJndiName();
}
}
}
/** return the ejb to whoch I refer.
*/
public EjbDescriptor getEjbDescriptor() {
return ejbDescriptor;
}
/**
* @return true if the EJB reference uses the local interfaces of the EJB
*/
public boolean isLocal() {
return isLocal;
}
/**
* Set whether this EJB Reference uses local interfaces or remote
* @param local true if the EJB reference use local interfaces
*/
public void setLocal(boolean local) {
this.isLocal = local;
}
/**
* Retusn the type of the ejb to whioch I refer.
*/
public String getType() {
if (ejbDescriptor==null) {
return refType;
} else {
return ejbDescriptor.getType();
}
}
/** Assigns the type of the ejb to whcoih I refer.
*/
public void setType(String type) {
refType=type;
}
public String getInjectResourceType() {
return isEJB30ClientView() ?
getEjbInterface() : getEjbHomeInterface();
}
public void setInjectResourceType(String resourceType) {
if (isEJB30ClientView()) {
setEjbInterface(resourceType);
} else {
setEjbHomeInterface(resourceType);
}
}
/**
* Gets the home classname of the referee EJB.
*/
public String getHomeClassName() {
return refHomeIntf;
}
/**
* Sets the home classname of the bean to whcioh I refer.
*/
public void setHomeClassName(String homeClassName) {
refHomeIntf = homeClassName;
}
/**
* @return the bean instance interface classname of the referee EJB.
*/
public String getBeanClassName() {
return refIntf;
}
/** Sets the bean instance business interface classname of the bean to which I refer.
* this interface is the local object or the remote interfaces depending if the
* reference is local or not.
*/
public void setBeanClassName(String remoteClassName) {
refIntf = remoteClassName;
}
/**
* Gets the home classname of the referee EJB.
* @return the class name of the EJB home.
*/
public String getEjbHomeInterface() {
return getHomeClassName();
}
/**
* Sets the local or remote home classname of the referee EJB.
* @param the class name of the EJB home.
*/
public void setEjbHomeInterface(String homeClassName) {
setHomeClassName(homeClassName);
}
/**
* Gets the local or remote interface classname of the referee EJB.
* @return the classname of the EJB remote object.
*/
public String getEjbInterface() {
return getBeanClassName();
}
/**
* Sets the local or remote bean interface classname of the referee EJB.
* @param the classname of the EJB remote object.
*/
public void setEjbInterface(String remoteClassName) {
setBeanClassName(remoteClassName);
}
/**
* @return true if the EJB reference is a 30 client view
*/
public boolean isEJB30ClientView() {
return (getHomeClassName() == null);
}
/** returns a formatted string representing me.
*/
public void print(StringBuffer toStringBuffer) {
if (ejbDescriptor!=null) {
toStringBuffer.append("Resolved Ejb-Ref ").append(getName()).append("@jndi: ").append(getJndiName()).append(
" - > ").append(ejbDescriptor.getName());
} else {
toStringBuffer.append("Unresolved Ejb-Ref ").append(getName()).append("@jndi: ").append(getJndiName()).append("@").append(
getEjbHomeInterface()).append("@").append(getEjbInterface()).append("@").append(refType).append("@").append(ejbLink) ;
}
}
/* Equality on name. */
public boolean equals(Object object) {
if (object instanceof EjbReference) {
EjbReference ejbReference = (EjbReference) object;
return ejbReference.getName().equals(this.getName());
}
return false;
}
}