RelationTypeSupportpublic class RelationTypeSupport extends Object implements RelationType| A RelationTypeSupport object implements the RelationType interface.
It represents a relation type, providing role information for each role
expected to be supported in every relation of that type.
A relation type includes a relation type name and a list of
role infos (represented by RoleInfo objects).
A relation type has to be declared in the Relation Service:
- either using the createRelationType() method, where a RelationTypeSupport
object will be created and kept in the Relation Service
- either using the addRelationType() method where the user has to create
an object implementing the RelationType interface, and this object will be
used as representing a relation type in the Relation Service. |
| Fields Summary |
|---|
| private static final long | oldSerialVersionUID | | private static final long | newSerialVersionUID | | private static final ObjectStreamField[] | oldSerialPersistentFields | | private static final ObjectStreamField[] | newSerialPersistentFields | | private static final long | serialVersionUID | | private static final ObjectStreamField[] | serialPersistentFields | | private static boolean | compat | | private String | typeName | | private Map | roleName2InfoMap | | private boolean | isInRelationService | | private static String | localClassName |
| Constructors Summary |
|---|
public RelationTypeSupport(String theRelTypeName, RoleInfo[] theRoleInfoArray)Constructor where all role definitions are dynamically created and
passed as parameter.
//
// Constructors
//
if (theRelTypeName == null || theRoleInfoArray == null) {
// Revisit [cebro] Localize message
String excMsg = "Invalid parameter.";
throw new IllegalArgumentException(excMsg);
}
if (isTraceOn())
trace("Constructor: entering", theRelTypeName);
// Can throw InvalidRelationTypeException, ClassNotFoundException
// and NotCompliantMBeanException
initMembers(theRelTypeName, theRoleInfoArray);
if (isTraceOn())
trace("Constructor: exiting", null);
return;
| protected RelationTypeSupport(String theRelTypeName)Constructor to be used for subclasses.
if (theRelTypeName == null) {
// Revisit [cebro] Localize message
String excMsg = "Invalid parameter.";
throw new IllegalArgumentException(excMsg);
}
if (isTraceOn())
trace("Protected constructor: entering", theRelTypeName);
typeName = theRelTypeName;
if (isTraceOn())
trace("Protected constructor: exiting", null);
return;
|
| Methods Summary |
|---|
| protected void | addRoleInfo(javax.management.relation.RoleInfo theRoleInfo)Add a role info.
This method of course should not be used after the creation of the
relation type, because updating it would invalidate that the relations
created associated to that type still conform to it.
Can throw a RuntimeException if trying to update a relation type
declared in the Relation Service.
if (theRoleInfo == null) {
// Revisit [cebro] Localize message
String excMsg = "Invalid parameter.";
throw new IllegalArgumentException(excMsg);
}
if (isDebugOn())
debug("addRoleInfo: entering", theRoleInfo.toString());
if (isInRelationService) {
// Trying to update a declared relation type
// Revisit [cebro] Localize message
String excMsg = "Relation type cannot be updated as it is declared in the Relation Service.";
throw new RuntimeException(excMsg);
}
String roleName = theRoleInfo.getName();
// Checks if the role info has already been described
if (roleName2InfoMap.containsKey(roleName)) {
StringBuffer excMsgStrB = new StringBuffer();
// Revisit [cebro] Localize message
String excMsg = "Two role infos provided for role ";
excMsgStrB.append(excMsg);
excMsgStrB.append(roleName);
throw new InvalidRelationTypeException(excMsgStrB.toString());
}
roleName2InfoMap.put(roleName,
new RoleInfo(theRoleInfo));
if (isDebugOn())
debug("addRoleInfo: exiting", null);
return;
| | static void | checkRoleInfos(javax.management.relation.RoleInfo[] theRoleInfoArray)
if (theRoleInfoArray == null) {
// Revisit [cebro] Localize message
String excMsg = "Invalid parameter.";
throw new IllegalArgumentException(excMsg);
}
if (theRoleInfoArray.length == 0) {
// No role info provided
// Revisit [cebro] Localize message
String excMsg = "No role info provided.";
throw new InvalidRelationTypeException(excMsg);
}
ArrayList roleNameList = new ArrayList();
for (int i = 0; i < theRoleInfoArray.length; i++) {
RoleInfo currRoleInfo = theRoleInfoArray[i];
if (currRoleInfo == null) {
// Revisit [cebro] Localize message
String excMsg = "Null role info provided.";
throw new InvalidRelationTypeException(excMsg);
}
String roleName = currRoleInfo.getName();
// Checks if the role info has already been described
if (roleNameList.contains(roleName)) {
StringBuffer excMsgStrB = new StringBuffer();
// Revisit [cebro] Localize message
String excMsg = "Two role infos provided for role ";
excMsgStrB.append(excMsg);
excMsgStrB.append(roleName);
throw new InvalidRelationTypeException(excMsgStrB.toString());
}
roleNameList.add(roleName);
}
return;
| | private void | debug(java.lang.String methodName, java.lang.String info)
Trace.send(Trace.LEVEL_DEBUG, Trace.INFO_RELATION, localClassName, methodName, info);
Trace.send(Trace.LEVEL_DEBUG, Trace.INFO_RELATION, "", "", "\n");
| | public java.lang.String | getRelationTypeName()Returns the relation type name.
return typeName;
| | public javax.management.relation.RoleInfo | getRoleInfo(java.lang.String theRoleInfoName)Returns the role info (RoleInfo object) for the given role info name
(null if not found).
if (theRoleInfoName == null) {
// Revisit [cebro] Localize message
String excMsg = "Invalid parameter.";
throw new IllegalArgumentException(excMsg);
}
if (isTraceOn())
trace("getRoleInfo: entering", theRoleInfoName);
// No null RoleInfo allowed, so use get()
RoleInfo result = (RoleInfo)(roleName2InfoMap.get(theRoleInfoName));
if (result == null) {
StringBuffer excMsgStrB = new StringBuffer();
// Revisit [cebro] Localize message
String excMsg = "No role info for role ";
excMsgStrB.append(excMsg);
excMsgStrB.append(theRoleInfoName);
throw new RoleInfoNotFoundException(excMsgStrB.toString());
}
if (isTraceOn())
trace("getRoleInfo: exiting", null);
return result;
| | public java.util.List | getRoleInfos()Returns the list of role definitions (ArrayList of RoleInfo objects).
return new ArrayList(roleName2InfoMap.values());
| | private void | initMembers(java.lang.String theRelTypeName, javax.management.relation.RoleInfo[] theRoleInfoArray)
if (theRelTypeName == null || theRoleInfoArray == null) {
// Revisit [cebro] Localize message
String excMsg = "Invalid parameter.";
throw new IllegalArgumentException(excMsg);
}
if (isDebugOn())
debug("initMembers: entering", theRelTypeName);
typeName = theRelTypeName;
// Verifies role infos before setting them
// Can throw InvalidRelationTypeException
checkRoleInfos(theRoleInfoArray);
for (int i = 0; i < theRoleInfoArray.length; i++) {
RoleInfo currRoleInfo = theRoleInfoArray[i];
roleName2InfoMap.put(new String(currRoleInfo.getName()),
new RoleInfo(currRoleInfo));
}
if (isDebugOn())
debug("initMembers: exiting", null);
return;
| | private boolean | isDebugOn()
return Trace.isSelected(Trace.LEVEL_DEBUG, Trace.INFO_RELATION);
| | private boolean | isTraceOn()
// trace level
return Trace.isSelected(Trace.LEVEL_TRACE, Trace.INFO_RELATION);
| | private void | readObject(java.io.ObjectInputStream in)Deserializes a {@link RelationTypeSupport} from an {@link ObjectInputStream}.
if (compat)
{
// Read an object serialized in the old serial form
//
ObjectInputStream.GetField fields = in.readFields();
typeName = (String) fields.get("myTypeName", null);
if (fields.defaulted("myTypeName"))
{
throw new NullPointerException("myTypeName");
}
roleName2InfoMap = (Map) fields.get("myRoleName2InfoMap", null);
if (fields.defaulted("myRoleName2InfoMap"))
{
throw new NullPointerException("myRoleName2InfoMap");
}
isInRelationService = fields.get("myIsInRelServFlg", false);
if (fields.defaulted("myIsInRelServFlg"))
{
throw new NullPointerException("myIsInRelServFlg");
}
}
else
{
// Read an object serialized in the new serial form
//
in.defaultReadObject();
}
| | void | setRelationServiceFlag(boolean theFlg)
isInRelationService = theFlg;
return;
| | private void | trace(java.lang.String methodName, java.lang.String info)
Trace.send(Trace.LEVEL_TRACE, Trace.INFO_RELATION, localClassName, methodName, info);
Trace.send(Trace.LEVEL_TRACE, Trace.INFO_RELATION, "", "", "\n");
| | private void | writeObject(java.io.ObjectOutputStream out)Serializes a {@link RelationTypeSupport} to an {@link ObjectOutputStream}.
if (compat)
{
// Serializes this instance in the old serial form
//
ObjectOutputStream.PutField fields = out.putFields();
fields.put("myTypeName", typeName);
fields.put("myRoleName2InfoMap", (HashMap)roleName2InfoMap);
fields.put("myIsInRelServFlg", isInRelationService);
out.writeFields();
}
else
{
// Serializes this instance in the new serial form
//
out.defaultWriteObject();
}
|
|
