org.glassfish.ejb.deployment.descriptor.EjbCMPEntityDescriptor Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-micro Show documentation
Show all versions of payara-micro Show documentation
Micro Distribution of the Payara Project
/*
* 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.
*/
// Portions Copyright [2019] Payara Foundation and/or affiliates
package org.glassfish.ejb.deployment.descriptor;
import com.sun.enterprise.util.LocalStringManagerImpl;
import org.glassfish.deployment.common.Descriptor;
import org.glassfish.ejb.deployment.BeanMethodCalculatorImpl;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
import java.util.Locale;
import java.util.Vector;
import java.util.logging.Level;
/**
* This class contains information about EJB1.1 and EJB2.0 CMP EntityBeans.
* @author Sanjeev Krishnan
*/
public class EjbCMPEntityDescriptor extends EjbEntityDescriptor {
private static final String FIELD_ACCESS_METHOD_PREFIX = "get"; // NOI18N
// Enum types to be returned from getVersionNumber().
public static final int UNDEFINED = -1;
public static final int CMP_1_1 = 1;
public static final int CMP_2_x = 2;
private int cmpVersion = UNDEFINED;
private PersistenceDescriptor pers;
private String abstractSchemaName=null;
private FieldDescriptor primaryKeyFieldDesc;
private String stateImplClassName=null;
private String ejbImplementationImplClassName=null;
private static LocalStringManagerImpl localStrings =
new LocalStringManagerImpl(EjbCMPEntityDescriptor.class);
public EjbCMPEntityDescriptor() {
this.setPersistenceType(CONTAINER_PERSISTENCE);
}
/**
* The copy constructor.
*/
public EjbCMPEntityDescriptor(EjbDescriptor other) {
super(other);
this.setPersistenceType(CONTAINER_PERSISTENCE);
if ( other instanceof EjbCMPEntityDescriptor ) {
EjbCMPEntityDescriptor entity = (EjbCMPEntityDescriptor)other;
this.pers = entity.pers;
this.cmpVersion = entity.cmpVersion;
this.abstractSchemaName = entity.abstractSchemaName;
}
}
/**
* Sets the State class implementation classname.
*/
public void setStateImplClassName(String name) {
this.stateImplClassName = name;
}
/**
* Returns the classname of the State class impl.
*/
public String getStateImplClassName() {
return this.stateImplClassName;
}
@Override
public Vector getFields() {
if( isEJB20() ) {
// All cmp "fields" are abstract, so we can't construct
// java.lang.reflect.Field elements from them. Use
// getFieldDescriptors() instead.
return new Vector<>();
}
return super.getFields();
}
@Override
public Vector getFieldDescriptors() {
Vector fieldDescriptors = new Vector<>();
if( isEJB20() ) {
try {
ClassLoader cl = getEjbBundleDescriptor().getClassLoader();
fieldDescriptors = BeanMethodCalculatorImpl.getPossibleCmpCmrFields(cl, this.getEjbClassName());
} catch(Throwable t) {
String errorMsg = localStrings.getLocalString
("enterprise.deployment.errorloadingejbclass",
"error loading the ejb class {0} in getFields" +
" on EjbDescriptor\n {1}",
new Object[] {this.getEjbClassName(), t.toString() });
_logger.log(Level.FINE,errorMsg);
}
} else {
fieldDescriptors = super.getFieldDescriptors();
}
return fieldDescriptors;
}
/**
* Returns CMP version as an enum type.
*/
public int getCMPVersion() {
if (cmpVersion == UNDEFINED) {
if (getEjbBundleDescriptor()!=null) {
String bundleVersion = getEjbBundleDescriptor().getSpecVersion();
if (bundleVersion.startsWith("1.")) {
cmpVersion = CMP_1_1;
} else {
cmpVersion = CMP_2_x;
}
} else {
// we cannot get the version from the bundle, set it to default...
cmpVersion = CMP_2_x;
}
}
return cmpVersion;
}
/**
* Set the CMP version
*/
public void setCMPVersion(int version) {
if (version==CMP_1_1 || version == CMP_2_x) {
cmpVersion = version;
} else {
throw new IllegalArgumentException(localStrings.getLocalString("enterprise.deployment.invalidcmpversion",
"Invalid CMP version: {0}.",
new Object[]{Integer.valueOf(version)})); // NOI18N
}
}
/**
* return true if this is an EJB2.0 CMP Entitybean
* DEPRECATED
*/
public boolean isEJB20() {
return getCMPVersion()==CMP_2_x;
}
@Override
public void setEjbBundleDescriptor(EjbBundleDescriptorImpl bundleDescriptor) {
super.setEjbBundleDescriptor(bundleDescriptor);
}
@Override
public Vector getPossibleTransactionAttributes() {
Vector txAttributes = null;
if( isEJB20() ) {
txAttributes = new Vector<>();
txAttributes.add(new ContainerTransaction
(ContainerTransaction.REQUIRED, ""));
txAttributes.add(new ContainerTransaction
(ContainerTransaction.REQUIRES_NEW, ""));
txAttributes.add(new ContainerTransaction
(ContainerTransaction.MANDATORY, ""));
if( isTimedObject() ) {
txAttributes.add(new ContainerTransaction
(ContainerTransaction.NOT_SUPPORTED, ""));
}
} else {
txAttributes = super.getPossibleTransactionAttributes();
}
return txAttributes;
}
public void setPersistenceDescriptor(PersistenceDescriptor pd)
{
this.pers = pd;
pd.setParentDescriptor(this);
}
public PersistenceDescriptor getPersistenceDescriptor()
{
if (pers==null) {
pers = new PersistenceDescriptor();
this.setPersistenceDescriptor(pers);
}
return pers;
}
private void invalidatePersistenceInfo() {
if( pers != null ) {
pers.invalidate();
}
}
public void setPrimaryKeyFieldDesc(FieldDescriptor pkf)
{
this.primaryKeyFieldDesc = pkf;
invalidatePersistenceInfo();
}
public FieldDescriptor getPrimaryKeyFieldDesc()
{
return primaryKeyFieldDesc;
}
public void setAbstractSchemaName(String abstractSchemaName)
{
this.abstractSchemaName = abstractSchemaName;
}
public String getAbstractSchemaName()
{
return abstractSchemaName;
}
/**
* set the generated implementation class for a CMP 2.0 Ejb object
* @param className the generated implementation
*/
public void setEjbImplementationImplClassName(String className) {
ejbImplementationImplClassName = className;
}
/**
* @return the generated implementation class
*/
public String getEjbImplementationImplClassName() {
return ejbImplementationImplClassName;
}
public static Vector getPossibleCmpCmrFields(ClassLoader cl, String className) throws Exception {
Vector fieldDescriptors = new Vector<>();
Class theClass = cl.loadClass(className);
// Start with all *public* methods
Method[] methods = theClass.getMethods();
// Find all accessors that could be cmp fields. This list
// will contain all cmr field accessors as well, since there
// is no good way to distinguish between the two purely based
// on method signature.
for(int mIndex = 0; mIndex < methods.length; mIndex++) {
Method next = methods[mIndex];
String nextName = next.getName();
int nextModifiers = next.getModifiers();
if( Modifier.isAbstract(nextModifiers) ) {
if( nextName.startsWith(FIELD_ACCESS_METHOD_PREFIX) &&
nextName.length() > 3 ) {
String field =
nextName.substring(3,4).toLowerCase(Locale.US) +
nextName.substring(4);
fieldDescriptors.add(new FieldDescriptor(field));
}
}
}
return fieldDescriptors;
}
/**
* Return my formatted string representation.
*/
@Override
public void print(StringBuilder toStringBuilder) {
super.print(toStringBuilder);
toStringBuilder.append("\n cmpVersion ").append(cmpVersion).
append("\n primKeyField ");
if(getPrimaryKeyFieldDesc() != null)
((Descriptor)getPrimaryKeyFieldDesc()).print(toStringBuilder);
if(pers != null)
((Descriptor)pers).print(toStringBuilder);
}
}