PrimaryKeyClassOptpublic class PrimaryKeyClassOpt extends com.sun.enterprise.tools.verifier.tests.ejb.EjbTest implements com.sun.enterprise.tools.verifier.tests.ejb.EjbCheck| Entity bean's Primary Key Class test.
If the enterprise bean is a Entity Bean, the Bean provider specifies
the fully qualified name of the Entity bean's primary key class in the
"" element. The Bean provider 'must' specify the primary key
class for an Entity with bean managed persistence, and 'may' (but is not
required to) specify the primary key class for an Entity with
Container-managed persistence.
Special case: Unknown primary key class
In special situations, the Bean Provider may choose not to specify the
primary key class for an entity bean with container-managed persistence. This
case happens if the Bean Provider wants to allow the Deployer to select the
primary key fields at deployment time. The Deployer uses instructions
supplied by the Bean Provider (these instructions are beyond the scope of
the EJB spec.) to define a suitable primary key class.
In this special case, the type of the argument of the findByPrimaryKey method
must be declared as java.lang.Object, and the return value of ejbCreate()
must be declared as java.lang.Object. The Bean Provider must specify the
primary key class in the deployment descriptor as the type
java.lang.Object.
The primary key class is specified at deployment time when the Bean Provider
develops enterprise beans that is intended to be used with multiple back-ends
that provide persistence, and when these multiple back-ends require different
primary key structures. |
| Fields Summary |
|---|
| Result | result | | ComponentNameConstructor | compName |
| Methods Summary |
|---|
| public Result | check(com.sun.enterprise.deployment.EjbDescriptor descriptor)Entity bean's Primary Key Class test.
If the enterprise bean is a Entity Bean, the Bean provider specifies
the fully qualified name of the Entity bean's primary key class in the
"" element. The Bean provider 'must' specify the primary
key class for an Entity with bean managed persistence, and 'may' (but is
not required to) specify the primary key class for an Entity with
Container-managed persistence.
Special case: Unknown primary key class
In special situations, the Bean Provider may choose not to specify the
primary key class for an entity bean with container-managed persistence. This
case happens if the Bean Provider wants to allow the Deployer to select the
primary key fields at deployment time. The Deployer uses instructions
supplied by the Bean Provider (these instructions are beyond the scope of
the EJB spec.) to define a suitable primary key class.
In this special case, the type of the argument of the findByPrimaryKey method
must be declared as java.lang.Object, and the return value of ejbCreate()
must be declared as java.lang.Object. The Bean Provider must specify the
primary key class in the deployment descriptor as of the type
java.lang.Object.
The primary key class is specified at deployment time when the Bean Provider
develops enterprise beans that is intended to be used with multiple back-ends
that provide persistence, and when these multiple back-ends require different
primary key structures.
result = getInitializedResult();
compName = getVerifierContext().getComponentNameConstructor();
boolean oneFailed = false;
if (descriptor instanceof EjbEntityDescriptor) {
String persistence =
((EjbEntityDescriptor)descriptor).getPersistenceType();
if (EjbEntityDescriptor.CONTAINER_PERSISTENCE.equals(persistence)) {
String primkey =
((EjbEntityDescriptor)descriptor).getPrimaryKeyClassName();
// primkey can be not set, via setting xml element
// <prim-key-class> to "java.lang.Object"
if (primkey.equals("java.lang.Object")) {
if(descriptor.getHomeClassName() != null && !"".equals(descriptor.getHomeClassName())) {
oneFailed = commonToBothInterfaces(descriptor.getHomeClassName(), descriptor);
}
if(oneFailed == false) {
if(descriptor.getLocalHomeClassName() != null && !"".equals(descriptor.getLocalHomeClassName())) {
oneFailed = commonToBothInterfaces(descriptor.getLocalHomeClassName(), descriptor);
}
}
} else {
result.addNaDetails(smh.getLocalString
("tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.notApplicable(smh.getLocalString
(getClass().getName() + ".notApplicable1",
"Primary Key Class is [ {0} ]",
new Object[] {primkey}));
}
return result;
} else if (EjbEntityDescriptor.BEAN_PERSISTENCE.equals(persistence)) {
result.addNaDetails(smh.getLocalString
("tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.notApplicable(smh.getLocalString
(getClass().getName() + ".notApplicable2",
"Entity Bean with [ {0} ] managed persistence, primkey mandatory.",
new Object[] {persistence}));
return result;
}
else {
result.addNaDetails(smh.getLocalString
("tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.notApplicable(smh.getLocalString
(getClass().getName() + ".notApplicable3",
"Expected [ {0} ] managed persistence, but [ {1} ] bean has [ {2} ] managed persistence.",
new Object[] {EjbEntityDescriptor.CONTAINER_PERSISTENCE,descriptor.getName(),persistence}));
return result;
}
} else {
result.addNaDetails(smh.getLocalString
("tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.addNaDetails(smh.getLocalString
("tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.notApplicable(smh.getLocalString
(getClass().getName() + ".notApplicable",
"[ {0} ] expected {1} bean, but called with {2} bean.",
new Object[] {getClass(),"Entity","Session"}));
return result;
}
| | private boolean | commonToBothInterfaces(java.lang.String home, com.sun.enterprise.deployment.EjbDescriptor descriptor)This method is responsible for the logic of the test. It is called for both local and remote interfaces.
boolean oneFailed = false;
try {
Context context = getVerifierContext();
ClassLoader jcl = context.getClassLoader();
Class c = Class.forName(home, false, getVerifierContext().getClassLoader());
Method [] ejbFinderMethods = c.getDeclaredMethods();
boolean paramValid = false;
for (int j = 0; j < ejbFinderMethods.length; ++j) {
// reset all booleans for next method within the loop
if (ejbFinderMethods[j].getName().equals("findByPrimaryKey")) {
Class [] ejbFinderMethodParameterTypes;
ejbFinderMethodParameterTypes = ejbFinderMethods[j].getParameterTypes();
for (int k = 0; k < ejbFinderMethodParameterTypes.length; ++k) {
if (ejbFinderMethodParameterTypes[k].getName().equals("java.lang.Object")) {
paramValid = true;
break;
}
}
}
}
if (paramValid) {
result.addGoodDetails(smh.getLocalString
("tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.passed(smh.getLocalString
(getClass().getName() + ".passed",
"findByPrimaryKey method properly defines method parameter [ {0} ]",
new Object[] {"java.lang.Object"}));
} else {
result.addErrorDetails(smh.getLocalString
("tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.failed(smh.getLocalString
(getClass().getName() + ".failed",
"Error: findByPrimaryKey method does not properly define method parameter [ {0} ]",
new Object[] {"java.lang.Object"}));
}
return oneFailed;
} catch (Exception e) {
Verifier.debug(e);
result.addErrorDetails(smh.getLocalString
("tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.failed(smh.getLocalString
(getClass().getName() + ".failedException",
"Error: Loading Home interface class [ {0} ]",
new Object[] {home}));
return oneFailed;
}
|
|
