javax.management.relation
Interface RelationServiceMBean

All Known Implementing Classes:

RelationService

public interface RelationServiceMBean

Version:

$Revision: 1.4 $

Author:

Bronwen Cassidy

Method Summary

void	addRelation(ObjectName relationObjectName)
void	addRelationType(RelationType relationTypeObject)
java.lang.Integer	checkRoleReading(java.lang.String roleName, java.lang.String relationTypeName)
java.lang.Integer	checkRoleWriting(Role role, java.lang.String relationTypeName, java.lang.Boolean initializeRoleFlag)
void	createRelation(java.lang.String relationId, java.lang.String relationTypeName, RoleList roleList)
void	createRelationType(java.lang.String relationTypeName, RoleInfo[] roleInfos)
java.util.Map	findAssociatedMBeans(ObjectName mbeanObjectName, java.lang.String relationTypeName, java.lang.String roleName)
java.util.Map	findReferencingRelations(ObjectName mbeanObjectName, java.lang.String relationTypeName, java.lang.String roleName)
java.util.List	findRelationsOfType(java.lang.String relationTypeName)
java.util.List	getAllRelationIds()
java.util.List	getAllRelationTypeNames()
RoleResult	getAllRoles(java.lang.String relationId)
boolean	getPurgeFlag()
java.util.Map	getReferencedMBeans(java.lang.String relationId)
java.lang.String	getRelationTypeName(java.lang.String relationId)
java.util.List	getRole(java.lang.String relationId, java.lang.String roleName)
java.lang.Integer	getRoleCardinality(java.lang.String relationId, java.lang.String roleName)
RoleInfo	getRoleInfo(java.lang.String relationTypeName, java.lang.String roleInfoName)
java.util.List	getRoleInfos(java.lang.String relationTypeName)
RoleResult	getRoles(java.lang.String relationId, java.lang.String[] roleNames)
java.lang.Boolean	hasRelation(java.lang.String relationId)
void	isActive()
java.lang.String	isRelation(ObjectName objectName)
ObjectName	isRelationMBean(java.lang.String relationId)
void	purgeRelations()
void	removeRelation(java.lang.String relationId)
void	removeRelationType(java.lang.String relationTypeName)
void	sendRelationCreationNotification(java.lang.String relationId)
void	sendRelationRemovalNotification(java.lang.String relationId, java.util.List unregisteredMBeanList)
void	sendRoleUpdateNotification(java.lang.String relationId, Role newRole, java.util.List oldRoleValues)
void	setPurgeFlag(boolean purgeFlag)
void	setRole(java.lang.String relationId, Role role)
RoleResult	setRoles(java.lang.String relationId, RoleList roleList)
void	updateRoleMap(java.lang.String relationId, Role newRole, java.util.List oldRoleValues)

Method Detail

isActive

void isActive()
              throws RelationServiceNotRegisteredException

Throws:

RelationServiceNotRegisteredException

getPurgeFlag

boolean getPurgeFlag()

setPurgeFlag

void setPurgeFlag(boolean purgeFlag)

createRelationType

void createRelationType(java.lang.String relationTypeName,
                        RoleInfo[] roleInfos)
                        throws java.lang.IllegalArgumentException,
                               InvalidRelationTypeException

Throws:

java.lang.IllegalArgumentException

InvalidRelationTypeException

addRelationType

void addRelationType(RelationType relationTypeObject)
                     throws java.lang.IllegalArgumentException,
                            InvalidRelationTypeException

Throws:

java.lang.IllegalArgumentException

InvalidRelationTypeException

getAllRelationTypeNames

java.util.List getAllRelationTypeNames()

getRoleInfos

java.util.List getRoleInfos(java.lang.String relationTypeName)
                            throws java.lang.IllegalArgumentException,
                                   RelationTypeNotFoundException

Throws:

java.lang.IllegalArgumentException

RelationTypeNotFoundException

getRoleInfo

RoleInfo getRoleInfo(java.lang.String relationTypeName,
                     java.lang.String roleInfoName)
                     throws java.lang.IllegalArgumentException,
                            RelationTypeNotFoundException,
                            RoleInfoNotFoundException

Throws:

java.lang.IllegalArgumentException

RelationTypeNotFoundException

RoleInfoNotFoundException

removeRelationType

void removeRelationType(java.lang.String relationTypeName)
                        throws java.lang.IllegalArgumentException,
                               RelationServiceNotRegisteredException,
                               RelationTypeNotFoundException

Throws:

java.lang.IllegalArgumentException

RelationServiceNotRegisteredException

RelationTypeNotFoundException

createRelation

void createRelation(java.lang.String relationId,
                    java.lang.String relationTypeName,
                    RoleList roleList)
                    throws java.lang.IllegalArgumentException,
                           RelationServiceNotRegisteredException,
                           RoleNotFoundException,
                           InvalidRelationIdException,
                           RelationTypeNotFoundException,
                           InvalidRoleValueException

Throws:

java.lang.IllegalArgumentException

RelationServiceNotRegisteredException

RoleNotFoundException

InvalidRelationIdException

RelationTypeNotFoundException

InvalidRoleValueException

addRelation

void addRelation(ObjectName relationObjectName)
                 throws java.lang.IllegalArgumentException,
                        RelationServiceNotRegisteredException,
                        java.lang.NoSuchMethodException,
                        InvalidRelationIdException,
                        InstanceNotFoundException,
                        InvalidRelationServiceException,
                        RelationTypeNotFoundException,
                        RoleNotFoundException,
                        InvalidRoleValueException

Throws:

java.lang.IllegalArgumentException

RelationServiceNotRegisteredException

java.lang.NoSuchMethodException

InvalidRelationIdException

InstanceNotFoundException

InvalidRelationServiceException

RelationTypeNotFoundException

RoleNotFoundException

InvalidRoleValueException

isRelationMBean

ObjectName isRelationMBean(java.lang.String relationId)
                           throws java.lang.IllegalArgumentException,
                                  RelationNotFoundException

Throws:

java.lang.IllegalArgumentException

RelationNotFoundException

isRelation

java.lang.String isRelation(ObjectName objectName)
                            throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

hasRelation

java.lang.Boolean hasRelation(java.lang.String relationId)
                              throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

getAllRelationIds

java.util.List getAllRelationIds()

checkRoleReading

java.lang.Integer checkRoleReading(java.lang.String roleName,
                                   java.lang.String relationTypeName)
                                   throws java.lang.IllegalArgumentException,
                                          RelationTypeNotFoundException

Throws:

java.lang.IllegalArgumentException

RelationTypeNotFoundException

checkRoleWriting

java.lang.Integer checkRoleWriting(Role role,
                                   java.lang.String relationTypeName,
                                   java.lang.Boolean initializeRoleFlag)
                                   throws java.lang.IllegalArgumentException,
                                          RelationTypeNotFoundException

Throws:

java.lang.IllegalArgumentException

RelationTypeNotFoundException

sendRelationCreationNotification

void sendRelationCreationNotification(java.lang.String relationId)
                                      throws java.lang.IllegalArgumentException,
                                             RelationNotFoundException

Throws:

java.lang.IllegalArgumentException

RelationNotFoundException

sendRoleUpdateNotification

void sendRoleUpdateNotification(java.lang.String relationId,
                                Role newRole,
                                java.util.List oldRoleValues)
                                throws java.lang.IllegalArgumentException,
                                       RelationNotFoundException

Throws:

java.lang.IllegalArgumentException

RelationNotFoundException

sendRelationRemovalNotification

void sendRelationRemovalNotification(java.lang.String relationId,
                                     java.util.List unregisteredMBeanList)
                                     throws java.lang.IllegalArgumentException,
                                            RelationNotFoundException

Throws:

java.lang.IllegalArgumentException

RelationNotFoundException

updateRoleMap

void updateRoleMap(java.lang.String relationId,
                   Role newRole,
                   java.util.List oldRoleValues)
                   throws java.lang.IllegalArgumentException,
                          RelationServiceNotRegisteredException,
                          RelationNotFoundException

Throws:

java.lang.IllegalArgumentException

RelationServiceNotRegisteredException

RelationNotFoundException

removeRelation

void removeRelation(java.lang.String relationId)
                    throws java.lang.IllegalArgumentException,
                           RelationServiceNotRegisteredException,
                           RelationNotFoundException

Throws:

java.lang.IllegalArgumentException

RelationServiceNotRegisteredException

RelationNotFoundException

purgeRelations

void purgeRelations()
                    throws RelationServiceNotRegisteredException

Throws:

RelationServiceNotRegisteredException

findReferencingRelations

java.util.Map findReferencingRelations(ObjectName mbeanObjectName,
                                       java.lang.String relationTypeName,
                                       java.lang.String roleName)
                                       throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

findAssociatedMBeans

java.util.Map findAssociatedMBeans(ObjectName mbeanObjectName,
                                   java.lang.String relationTypeName,
                                   java.lang.String roleName)
                                   throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

findRelationsOfType

java.util.List findRelationsOfType(java.lang.String relationTypeName)
                                   throws java.lang.IllegalArgumentException,
                                          RelationTypeNotFoundException

Throws:

java.lang.IllegalArgumentException

RelationTypeNotFoundException

getRole

java.util.List getRole(java.lang.String relationId,
                       java.lang.String roleName)
                       throws java.lang.IllegalArgumentException,
                              RelationServiceNotRegisteredException,
                              RelationNotFoundException,
                              RoleNotFoundException

Throws:

java.lang.IllegalArgumentException

RelationServiceNotRegisteredException

RelationNotFoundException

RoleNotFoundException

getRoles

RoleResult getRoles(java.lang.String relationId,
                    java.lang.String[] roleNames)
                    throws java.lang.IllegalArgumentException,
                           RelationNotFoundException,
                           RelationServiceNotRegisteredException

Throws:

java.lang.IllegalArgumentException

RelationNotFoundException

RelationServiceNotRegisteredException

getAllRoles

RoleResult getAllRoles(java.lang.String relationId)
                       throws java.lang.IllegalArgumentException,
                              RelationNotFoundException,
                              RelationServiceNotRegisteredException

Throws:

java.lang.IllegalArgumentException

RelationNotFoundException

RelationServiceNotRegisteredException

getRoleCardinality

java.lang.Integer getRoleCardinality(java.lang.String relationId,
                                     java.lang.String roleName)
                                     throws java.lang.IllegalArgumentException,
                                            RelationNotFoundException,
                                            RoleNotFoundException

Throws:

java.lang.IllegalArgumentException

RelationNotFoundException

RoleNotFoundException

setRole

void setRole(java.lang.String relationId,
             Role role)
             throws java.lang.IllegalArgumentException,
                    RelationServiceNotRegisteredException,
                    RelationNotFoundException,
                    RoleNotFoundException,
                    InvalidRoleValueException,
                    RelationTypeNotFoundException

Throws:

java.lang.IllegalArgumentException

RelationServiceNotRegisteredException

RelationNotFoundException

RoleNotFoundException

InvalidRoleValueException

RelationTypeNotFoundException

setRoles

RoleResult setRoles(java.lang.String relationId,
                    RoleList roleList)
                    throws RelationServiceNotRegisteredException,
                           java.lang.IllegalArgumentException,
                           RelationNotFoundException

Throws:

RelationServiceNotRegisteredException

java.lang.IllegalArgumentException

RelationNotFoundException

getReferencedMBeans

java.util.Map getReferencedMBeans(java.lang.String relationId)
                                  throws java.lang.IllegalArgumentException,
                                         RelationNotFoundException

Throws:

java.lang.IllegalArgumentException

RelationNotFoundException

getRelationTypeName

java.lang.String getRelationTypeName(java.lang.String relationId)
                                     throws java.lang.IllegalArgumentException,
                                            RelationNotFoundException

Throws:

java.lang.IllegalArgumentException

RelationNotFoundException