javax.management.relation
인터페이스 RelationServiceMBean

알려진 구현 클래스 목록:

RelationService

public interface RelationServiceMBean

관계 서비스에는 관계형과 관계의 작성 및 삭제, 정합성의 처리 및 쿼리도구 의 제공의 기능이 있습니다.

도입된 버전 :

1.5

메서드 개요

void	addRelation (ObjectName theRelObjectName) 사용자에 의해 작성되어 MBean Server에 등록되는 MBean를, 관계로서 관계 서비스에 추가합니다.
void	addRelationType (RelationType theRelTypeObj) 지정된 객체를 관계형으로서 추가합니다.
Integer	checkRoleReading (String theRoleName, String theRelTypeName) 지정된 형태의 관계로 지정된 Role 독해가 가능한가 어떤가를 체크합니다.
Integer	checkRoleWriting (Role theRole, String theRelTypeName, Boolean theInitFlg) 지정된 형태의 관계로 지정된 Role 설정이 가능한가 어떤가를 체크합니다.
void	createRelation (String theRelId, String theRelTypeName, RoleList theRoleList) 지정된 관계형의 단순한 관계 (RelationSupport 객체)를 작성해, 이것을 관계 서비스에 추가합니다.
void	createRelationType (String theRelTypeName, RoleInfo [] theRoleInfoArray) RoleInfo 객체로부터 제공된 롤 정보를 사용해, 관계형 (RelationTypeSupport 객체)을 작성해, 관계 서비스에 추가합니다.
Map	findAssociatedMBeans (ObjectName theMBeanName, String theRelTypeName, String theRoleName) 관계내의 지정된 MBean에 관련된 MBean를 취득합니다.
Map	findReferencingRelations (ObjectName theMBeanName, String theRelTypeName, String theRoleName) 지정된 MBean가 참조되는 관계를 취득합니다.
List	findRelationsOfType (String theRelTypeName) 지정된 형태의 관계의 관계 ID를 리턴합니다.
List	getAllRelationIds () 관계 서비스에 의해 처리되는 모든 관계의 모든 관계 ID를 리턴합니다.
List	getAllRelationTypeNames () 기존의 모든 관계형의 이름을 취득합니다.
RoleResult	getAllRoles (String theRelId) 관계에 포함되는 모든 롤을 리턴합니다.
boolean	getPurgeFlag () 관계내의 참조 대상의 MBean 등록 해제의 통지를 언제 수신했는지, 관계를 즉시 「퍼지」 (유효하지 않게 된 관계를 검색) 할 필요가 있을지 어떨지, 또는 purgeRelations 메서드가 명시적으로 호출되는 경우에게만 퍼지가 실행될지 어떨지를 나타내는 플래그를 리턴합니다.
Map	getReferencedMBeans (String theRelId) 관계의 다양한 롤로 참조되는 MBean를 취득합니다.
String	getRelationTypeName (String theRelId) 지정된 관계의 관계형의 이름을 리턴합니다.
List	getRole (String theRelId, String theRoleName) 지정된 관계에 포함되는 지정된 롤명의 롤치를 취득합니다.
Integer	getRoleCardinality (String theRelId, String theRoleName) 지정된 롤내에서 현재 참조되고 있는 MBean 수를 취득합니다.
RoleInfo	getRoleInfo (String theRelTypeName, String theRoleInfoName) 지정된 관계형의 지정된 롤의 정보를 취득합니다.
List	getRoleInfos (String theRelTypeName) 지정된 관계형의 롤 정보 (RoleInfo 객체)의 리스트를 취득합니다.
RoleResult	getRoles (String theRelId, String [] theRoleNameArray) 지정된 관계에 포함되는 지정된 이름의 롤의 값을 취득합니다.
Boolean	hasRelation (String theRelId) 관계 서비스내로 지정된 관계 ID 로 식별되는 관계가 있을지 어떨지를 체크합니다.
void	isActive () 관계 서비스가 활성화되었는가 어떤가를 체크합니다.
String	isRelation (ObjectName theObjName) MBean가 관계로서 관계 서비스에 추가되고 있는 경우, 지정된 ObjectName에 관련된 관계 ID를 리턴합니다.
ObjectName	isRelationMBean (String theRelId) 사용자에 의해 작성되어 관계로서 관계 서비스에 추가된 MBean가 관계를 나타내는 경우, 이 MBean ObjectName를 리턴합니다.
void	purgeRelations () 관계를 퍼지 합니다.
void	removeRelation (String theRelId) 지정된 관계형을 관계 서비스로부터 삭제합니다.
void	removeRelationType (String theRelTypeName) 지정된 관계형을 관계 서비스로부터 삭제합니다.
void	sendRelationCreationNotification (String theRelId) 관계 작성의 통지 (RelationNotification)를 송신합니다.
void	sendRelationRemovalNotification (String theRelId, List theUnregMBeanList) 관계 삭제의 통지 (RelationNotification)를 송신합니다.
void	sendRoleUpdateNotification (String theRelId, Role theNewRole, List theOldRoleValue) 지정된 관계내의 롤 갱신의 통지 (RelationNotification)를 송신합니다.
void	setPurgeFlag (boolean thePurgeFlg) 관계내의 참조 대상의 MBean 등록 해제의 통지를 언제 수신했는지, 관계를 즉시 「퍼지」 (유효하지 않게 된 관계를 검색) 할 필요가 있을지 어떨지, 또는 purgeRelations 메서드가 명시적으로 호출되는 경우에게만 퍼지가 실행될지 어떨지를 나타내는 플래그를 설정합니다.
void	setRole (String theRelId, Role theRole) 지정된 관계내의 지정된 롤을 설정합니다.
RoleResult	setRoles (String theRelId, RoleList theRoleList) 지정된 관계내의 지정된 롤을 설정합니다.
void	updateRoleMap (String theRelId, Role theNewRole, List theOldRoleValue) 지정된 관계내의 지정된 롤을 갱신하기 위해, 관계 서비스 롤 맵의 갱신을 처리합니다.

메서드의 상세

isActive

void isActive()
              throws RelationServiceNotRegisteredException 

관계 서비스가 활성화되었는가 어떤가를 체크합니다. 현재, 관계 서비스를 MBean Server에 등록할 필요가 있습니다.

예외:

RelationServiceNotRegisteredException - 관계 서비스가 미등록의 경우

getPurgeFlag

boolean getPurgeFlag()

관계내의 참조 대상의 MBean 등록 해제의 통지를 언제 수신했는지, 관계를 즉시 「퍼지」 (유효하지 않게 된 관계를 검색) 할 필요가 있을지 어떨지, 또는 purgeRelations 메서드가 명시적으로 호출되는 경우에게만 퍼지가 실행될지 어떨지를 나타내는 플래그를 리턴합니다.

true인 경우, 즉시 퍼지를 실시할 필요가 있습니다.

반환값:

즉시 퍼지를 하는 경우는 true

관련 항목:

setPurgeFlag(boolean)

setPurgeFlag

void setPurgeFlag(boolean thePurgeFlg)

관계내의 참조 대상의 MBean 등록 해제의 통지를 언제 수신했는지, 관계를 즉시 「퍼지」 (유효하지 않게 된 관계를 검색) 할 필요가 있을지 어떨지, 또는 purgeRelations 메서드가 명시적으로 호출되는 경우에게만 퍼지가 실행될지 어떨지를 나타내는 플래그를 설정합니다.

true인 경우, 즉시 퍼지를 실시할 필요가 있습니다.

파라미터:

thePurgeFlg - 플래그

관련 항목:

getPurgeFlag()

createRelationType

void createRelationType(String  theRelTypeName,
                        RoleInfo [] theRoleInfoArray)
                        throws IllegalArgumentException,

                               InvalidRelationTypeException 

RoleInfo 객체로부터 제공된 롤 정보를 사용해, 관계형 (RelationTypeSupport 객체)을 작성해, 관계 서비스에 추가합니다.

파라미터:

theRelTypeName - 관계형의 이름

theRoleInfoArray - 롤 정보의 배열

예외:

IllegalArgumentException - 파라미터가 null인 경우

InvalidRelationTypeException - 다음의 조건이 성립하는 경우:

- 같은 이름의 관계형이 이미 존재하는 경우

- 같은 이름이 2개가 다른 롤 정보로 사용되고 있는 경우

- 롤 정보가 제공되지 않았던 경우

- 롤 정보로서 null이 제공되었을 경우

addRelationType

void addRelationType(RelationType  theRelTypeObj)
                     throws IllegalArgumentException,

                            InvalidRelationTypeException 

지정된 객체를 관계형으로서 추가합니다. 이 객체는 RelationType 인터페이스를 구현할 필요가 있습니다.

파라미터:

theRelTypeObj - 관계형 객체 (RelationType 인터페이스를 구현)

예외:

IllegalArgumentException - 파라미터가 null인 경우

InvalidRelationTypeException - 같은 이름의 관계형이 이미 존재하는 경우

getAllRelationTypeNames

List  getAllRelationTypeNames()

기존의 모든 관계형의 이름을 취득합니다.

반환값:

관계형의 이름 (String)의 ArrayList

getRoleInfos

List  getRoleInfos(String  theRelTypeName)
                  throws IllegalArgumentException,

                         RelationTypeNotFoundException 

지정된 관계형의 롤 정보 (RoleInfo 객체)의 리스트를 취득합니다.

파라미터:

theRelTypeName - 관계형의 이름

반환값:

RoleInfo ArrayList

예외:

IllegalArgumentException - 파라미터가 null인 경우

RelationTypeNotFoundException - 그 이름의 관계형이 존재하지 않는 경우

getRoleInfo

RoleInfo  getRoleInfo(String  theRelTypeName,
                     String  theRoleInfoName)
                     throws IllegalArgumentException,

                            RelationTypeNotFoundException,

                            RoleInfoNotFoundException 

지정된 관계형의 지정된 롤의 정보를 취득합니다.

파라미터:

theRelTypeName - 관계형의 이름

theRoleInfoName - 롤명

반환값:

RoleInfo 객체

예외:

IllegalArgumentException - 파라미터가 null인 경우

RelationTypeNotFoundException - 관계 서비스에 있어 미지의 관계형인 경우

RoleInfoNotFoundException - 관계형에 롤이 포함되지 않은 경우

removeRelationType

void removeRelationType(String  theRelTypeName)
                        throws RelationServiceNotRegisteredException,

                               IllegalArgumentException,

                               RelationTypeNotFoundException 

지정된 관계형을 관계 서비스로부터 삭제합니다.

그 형태의 관계 객체가 관계 서비스로부터 삭제됩니다.

파라미터:

theRelTypeName - 삭제되는 관계형의 이름

예외:

RelationServiceNotRegisteredException - 관계 서비스가 MBean Server에 등록되지 않은 경우

IllegalArgumentException - 파라미터가 null인 경우

RelationTypeNotFoundException - 그 이름의 관계형이 존재하지 않는 경우

createRelation

void createRelation(String  theRelId,
                    String  theRelTypeName,
                    RoleList  theRoleList)
                    throws RelationServiceNotRegisteredException,

                           IllegalArgumentException,

                           RoleNotFoundException,

                           InvalidRelationIdException,

                           RelationTypeNotFoundException,

                           InvalidRoleValueException 

지정된 관계형의 단순한 관계 (RelationSupport 객체)를 작성해, 이것을 관계 서비스에 추가합니다.

롤은 파라미터로 지정된 롤 리스트에 따라 초기화됩니다. 이 방법으로 초기화되지 않는 롤은 ObjectName 비어있는 ArrayList 로 설정됩니다.

RELATION_BASIC_CREATION 형의 RelationNotification가 송신됩니다.

파라미터:

theRelId - 관계 서비스내의 관계를 일의에 식별하기 위해서 사용되는 관계 식별자

theRelTypeName - 관계 서비스내에 작성할 필요가 있는 관계형의 이름

theRoleList - 관계의 롤을 초기화하기 위한 롤 리스트 (null도 가능)

예외:

RelationServiceNotRegisteredException - 관계 서비스가 MBean Server에 등록되지 않은 경우

IllegalArgumentException - 파라미터가 null인 경우

RoleNotFoundException - 관계형내에 존재하지 않는 롤에 값이 제공되었을 경우

InvalidRelationIdException - 관계 ID가 이미 사용되고 있는 경우

RelationTypeNotFoundException - 관계 서비스에 있어 미지의 관계형인 경우

InvalidRoleValueException - 다음의 조건이 성립하는 경우:

- 같은 이름이 2개가 다른 롤로 사용되고 있는 경우

- 지정된 값에 포함되는 참조 대상의 MBean 수가 예상 최소값보다 작은 경우

- 지정된 값에 포함되는 참조 대상의 MBean 수가 예상 최대값을 넘고 있는 경우

- 치에 포함되는 참조 대상의 MBean 중 1개이, 그 롤의 MBean 클래스의 객체가 아닌 경우

- 그 롤의 MBean가 존재하지 않는 경우

addRelation

void addRelation(ObjectName  theRelObjectName)
                 throws IllegalArgumentException,

                        RelationServiceNotRegisteredException,

                        NoSuchMethodException,

                        InvalidRelationIdException,

                        InstanceNotFoundException,

                        InvalidRelationServiceException,

                        RelationTypeNotFoundException,

                        RoleNotFoundException,

                        InvalidRoleValueException 

사용자에 의해 작성되어 MBean Server에 등록되는 MBean를, 관계로서 관계 서비스에 추가합니다.

MBean를 관계로서 추가하기 위해서는 다음의 조건이 채워지고 있을 필요가 있습니다.

- MBean가 Relation 인터페이스를 구현하고 있다

- MBean가 RelationService ObjectName 용으로서 현재의 관계 서비스의 ObjectName를 가지고 있다

- MBean가 현재의 관계 서비스내에서 하나의 또한 미사용의 관계 ID를 가지고 있다

- MBean가 관계형용으로서 관계 서비스내에서 작성된 관계형을 가지고 있다

- MBean가 관계형내에서 제공된 롤 정보에 적합하는 롤을 가지고 있다

파라미터:

theRelObjectName - 추가되는 관계 MBean ObjectName

예외:

IllegalArgumentException - 파라미터가 null인 경우

RelationServiceNotRegisteredException - 관계 서비스가 MBean Server에 등록되지 않은 경우

NoSuchMethodException - MBean가 Relation 인터페이스를 구현하고 있지 않는 경우

InvalidRelationIdException - 다음의 조건이 성립하는 경우:

- MBean 내에 관계 식별자가 존재하지 않는

- 관계 식별자가 관계 서비스로 이미 사용되고 있는 경우

InstanceNotFoundException - 지정된 ObjectName MBean가 등록되지 않은 경우

InvalidRelationServiceException - 다음의 조건이 성립하는 경우:

- MBean 내에 관계 서비스명이 존재하지 않는 경우

- MBean 내의 관계 서비스명이 현재의 관계 서비스의 관계 서비스명이 아닌 경우

RelationTypeNotFoundException - 다음의 조건이 성립하는 경우:

- MBean 내에 관계형명이 존재하지 않는 경우

- MBean 내의 관계형명이 관계 서비스내에 작성된 관계형에 대응하고 있지 않는 경우

InvalidRoleValueException - 다음의 조건이 성립하는 경우:

- 롤에 포함되는 참조 대상의 MBean 수가 예상 최소값보다 작은 경우

- 롤에 포함되는 참조 대상의 MBean 수가 예상 최대값을 넘고 있는 경우

- 치에 포함되는 참조 대상의 MBean 중 1개이, 그 롤의 MBean 클래스의 객체가 아닌 경우

- 롤에 제공된 MBean가 존재하지 않는 경우

RoleNotFoundException - 관계형내에 존재하지 않는 롤에 값이 제공되었을 경우

isRelationMBean

ObjectName  isRelationMBean(String  theRelId)
                           throws IllegalArgumentException,

                                  RelationNotFoundException 

사용자에 의해 작성되어 관계로서 관계 서비스에 추가된 MBean가 관계를 나타내는 경우, 이 MBean ObjectName를 리턴합니다.

파라미터:

theRelId - 관계를 식별하는 관계 ID

반환값:

대응하는 관계 MBean ObjectName. 관계가 MBean가 아닌 경우는 null

예외:

IllegalArgumentException - 파라미터가 null인 경우

RelationNotFoundException - 이 ID에 관계를 관련지을 수 있지 않은 경우

isRelation

String  isRelation(ObjectName  theObjName)
                  throws IllegalArgumentException 

MBean가 관계로서 관계 서비스에 추가되고 있는 경우, 지정된 ObjectName에 관련된 관계 ID를 리턴합니다.

파라미터:

theObjName - 가정된 관계의 ObjectName

반환값:

관계 ID (String). ObjectName가 관계 서비스에 의해 처리되는 관계가 아닌 경우는 null

예외:

IllegalArgumentException - 파라미터가 null인 경우

hasRelation

Boolean  hasRelation(String  theRelId)
                    throws IllegalArgumentException 

관계 서비스내로 지정된 관계 ID 로 식별되는 관계가 있을지 어떨지를 체크합니다.

파라미터:

theRelId - 관계를 식별하는 관계 ID

반환값:

boolean 형. 관계가 존재하는 경우는 true, 존재하지 않는 경우는 false

예외:

IllegalArgumentException - 파라미터가 null인 경우

getAllRelationIds

List  getAllRelationIds()

관계 서비스에 의해 처리되는 모든 관계의 모든 관계 ID를 리턴합니다.

반환값:

String ArrayList

checkRoleReading

Integer  checkRoleReading(String  theRoleName,
                         String  theRelTypeName)
                         throws IllegalArgumentException,

                                RelationTypeNotFoundException 

지정된 형태의 관계로 지정된 Role 독해가 가능한가 어떤가를 체크합니다.

파라미터:

theRoleName - 체크되는 롤의 이름

theRelTypeName - 관계형의 이름

반환값:

발원시가능성이 있는 문제에 대응하는 정수형 (RoleUnresolved 내의 정수로 나타내진다)을감싸는 Integer

- 롤의 독해가 가능한 경우는 0

- RoleStatus.NO_ROLE_WITH_NAME에 대응하는 정수형

- RoleStatus.ROLE_NOT_READABLE에 대응하는 정수형

예외:

IllegalArgumentException - 파라미터가 null인 경우

RelationTypeNotFoundException - 관계 서비스에 있어 미지의 관계형인 경우

checkRoleWriting

Integer  checkRoleWriting(Role  theRole,
                         String  theRelTypeName,
                         Boolean  theInitFlg)
                         throws IllegalArgumentException,

                                RelationTypeNotFoundException 

지정된 형태의 관계로 지정된 Role 설정이 가능한가 어떤가를 체크합니다.

파라미터:

theRole - 체크되는 롤

theRelTypeName - 관계형의 이름

theInitFlg - 롤의 초기화를 위해서 체크를 한 것을 나타내는 플래그. 출력 액세스의 검증은 행해지지 않는다

반환값:

발원시가능성이 있는 문제에 대응하는 정수형 (RoleUnresolved 내의 정수로 나타내진다)을감싸는 Integer

- 롤의 설정이 가능한 경우는 0

- RoleStatus.NO_ROLE_WITH_NAME에 대응하는 정수형

- RoleStatus.ROLE_NOT_WRITABLE 정수형

- RoleStatus.LESS_THAN_MIN_ROLE_DEGREE 정수형

- RoleStatus.MORE_THAN_MAX_ROLE_DEGREE 정수형

- RoleStatus.REF_MBEAN_OF_INCORRECT_CLASS 정수형

- RoleStatus.REF_MBEAN_NOT_REGISTERED 정수형

예외:

IllegalArgumentException - 파라미터가 null인 경우

RelationTypeNotFoundException - 미지의 관계형의 경우

sendRelationCreationNotification

void sendRelationCreationNotification(String  theRelId)
                                      throws IllegalArgumentException,

                                             RelationNotFoundException 

관계 작성의 통지 (RelationNotification)를 송신합니다. 통지형은 다음과 같습니다.

- RelationNotification.RELATION_BASIC_CREATION. 관계가 관계 서비스의 내부 객체인 경우

- RelationNotification.RELATION_MBEAN_CREATION. 관계가 관계로서 추가된 MBean 인 경우

소스 객체는 관계 서비스 자체입니다.

관계 서비스의 createRelation() 메서드 및 addRelation() 메서드로 호출합니다.

파라미터:

theRelId - 갱신된 관계의 관계 식별자

예외:

IllegalArgumentException - 파라미터가 null인 경우

RelationNotFoundException - 지정된 관계 ID 관계가 존재하지 않는 경우

sendRoleUpdateNotification

void sendRoleUpdateNotification(String  theRelId,
                                Role  theNewRole,
                                List  theOldRoleValue)
                                throws IllegalArgumentException,

                                       RelationNotFoundException 

지정된 관계내의 롤 갱신의 통지 (RelationNotification)를 송신합니다. 통지형은 다음과 같습니다.

- RelationNotification.RELATION_BASIC_UPDATE. 관계가 관계 서비스의 내부 객체인 경우

- RelationNotification.RELATION_MBEAN_UPDATE. 관계가 관계로서 추가된 MBean 인 경우

소스 객체는 관계 서비스 자체입니다.

관계 MBean setRole() 메서드 (지정된 롤용) 및 setRoles() 메서드 ( 각 롤용)로 호출합니다. 이 구현은 RelationSupport 클래스에서 제공됩니다.

관계 서비스의 setRole() 메서드 (지정된 롤용) 및 setRoles() 메서드 ( 각 롤용)에서도 호출할 수 있습니다.

파라미터:

theRelId - 갱신된 관계의 관계 식별자

theNewRole - 새로운 롤 (이름과 새로운 값)

theOldRoleValue - 낡은 롤치 (ObjectName 객체의 List)

예외:

IllegalArgumentException - 파라미터가 null인 경우

RelationNotFoundException - 지정된 관계 ID 관계가 존재하지 않는 경우

sendRelationRemovalNotification

void sendRelationRemovalNotification(String  theRelId,
                                     List  theUnregMBeanList)
                                     throws IllegalArgumentException,

                                            RelationNotFoundException 

관계 삭제의 통지 (RelationNotification)를 송신합니다. 통지형은 다음과 같습니다.

- RelationNotification.RELATION_BASIC_REMOVAL. 관계가 관계 서비스의 내부 객체인 경우

- RelationNotification.RELATION_MBEAN_REMOVAL. 관계가 관계로서 추가된 MBean 인 경우

소스 객체는 관계 서비스 자체입니다.

관계 서비스의 removeRelation() 메서드로 호출합니다.

파라미터:

theRelId - 갱신된 관계의 관계 식별자

theUnregMBeanList - 관계의 삭제의 결과, 등록 해제되는 MBean ObjectName 리스트 (null도 가능)

예외:

IllegalArgumentException - 파라미터가 null인 경우

RelationNotFoundException - 지정된 관계 ID 관계가 존재하지 않는 경우

updateRoleMap

void updateRoleMap(String  theRelId,
                   Role  theNewRole,
                   List  theOldRoleValue)
                   throws IllegalArgumentException,

                          RelationServiceNotRegisteredException,

                          RelationNotFoundException 

지정된 관계내의 지정된 롤을 갱신하기 위해, 관계 서비스 롤 맵의 갱신을 처리합니다.

관계 MBean setRole() 메서드 (지정된 롤용) 및 setRoles() 메서드 ( 각 롤용)로 호출합니다. 이 구현은 RelationSupport 클래스에서 제공됩니다.

관계 서비스의 setRole() 메서드 (지정된 롤용) 및 setRoles() 메서드 ( 각 롤용)에서도 호출할 수 있습니다.

관계 서비스가 MBean 등록 해제시도 정합성을 확보해, 쿼리를 실행할 수 있도록 하려면, 롤의 갱신시에 이 메서드를 호출할 필요가 있습니다.

파라미터:

theRelId - 갱신된 관계의 관계 식별자

theNewRole - 새로운 롤 (이름과 새로운 값)

theOldRoleValue - 낡은 롤치 (ObjectName 객체의 List)

예외:

IllegalArgumentException - 파라미터가 null인 경우

RelationServiceNotRegisteredException - 관계 서비스가 MBean Server에 등록되지 않은 경우

RelationNotFoundException - 지정된 ID에 대응하는 관계가 존재하지 않는 경우

removeRelation

void removeRelation(String  theRelId)
                    throws RelationServiceNotRegisteredException,

                           IllegalArgumentException,

                           RelationNotFoundException 

지정된 관계형을 관계 서비스로부터 삭제합니다.

RelationNotification 통지가 송신됩니다. 그 형태는 다음과 같습니다.

- RelationNotification.RELATION_BASIC_REMOVAL. 관계 서비스내 전용의 관계인 경우

- RelationNotification.RELATION_MBEAN_REMOVAL. 관계가 MBean 로서 등록되어 있는 경우

이러한 관계로 참조되는 MBean인 경우, 아무것도 행해지지 않습니다.

파라미터:

theRelId - 삭제되는 관계의 관계 ID

예외:

RelationServiceNotRegisteredException - 관계 서비스가 MBean Server에 등록되지 않은 경우

IllegalArgumentException - 파라미터가 null인 경우

RelationNotFoundException - 지정된 관계 ID에 대응하는 관계가 존재하지 않는 경우

purgeRelations

void purgeRelations()
                    throws RelationServiceNotRegisteredException 

관계를 퍼지 합니다.

이 메서드는 purgeFlag 치에 의존합니다. 플래그가 true 로 설정되어 있는 경우는 관계내의 참조 대상의 MBean 등록 해제를 알리는 통지를 수신했을 때 자동적으로 호출합니다. 플래그가 false 로 설정되어 있는 경우는 불려가 지 않습니다.

플래그가 false 로 설정되어 있는 경우, 관계의 정합성을 확보하기 위해서 이 메서드를 호출할지 어떨지는 사용자가 결정합니다. MBean 등록이 해제된 뒤 즉시 퍼지를 하지 않는 경우, ObjectName가 재이용되어 관계내의 참조 대상의 다른 MBean에 할당할 수 있을 때 이 purgeRelations() 메서드를 수동으로 호출하면, 문제가 발생합니다. 이것은 새로운 MBean가 인식되지 않고, ObjectName가 등록 해제된 MBean에 대응한다고 보여지기 때문입니다.

동작은 등록 해제된 MBean가 참조되는 롤의 카디나리티에 결정됩니다.

- 롤내의 MBean 참조를 1개 삭제했을 때 참조의 수가 최소값보다 적게 되는 경우는 관계를 삭제할 필요가 있다

- MBean 참조를 삭제한 뒤 남은 참조의 수가 카디나리티 범위내인 경우는 관계를 보관 유지해, handleMBeanUnregistration() 콜백을 호출해 갱신한다

예외:

RelationServiceNotRegisteredException - 관계 서비스가 MBean Server에 등록되지 않은 경우

findReferencingRelations

Map  findReferencingRelations(ObjectName  theMBeanName,
                             String  theRelTypeName,
                             String  theRoleName)
                             throws IllegalArgumentException 

지정된 MBean가 참조되는 관계를 취득합니다.

이것은 CIM 「Reference」 및 「ReferenceName」오퍼레이션에 대응합니다.

파라미터:

theMBeanName - MBean ObjectName

theRelTypeName - null도 가능. 지정했을 경우, 검색에서는 그 형태의 관계만이 고려된다. 그 외의 경우, 모든 관계형이 고려되는

theRoleName - null도 가능. 지정했을 경우, 그 롤내의 MBean가 참조되는 관계만이 리턴된다. 그 외의 경우, 모든 롤이 고려된다

반환값:

HashMap. 키는 MBean가 참조되는 관계의 관계 ID. 각 키의 값은 롤명의 ArrayList (MBean는 같은 관계의 복수의 롤내에서 참조 가능)

예외:

IllegalArgumentException - 파라미터가 null인 경우

findAssociatedMBeans

Map  findAssociatedMBeans(ObjectName  theMBeanName,
                         String  theRelTypeName,
                         String  theRoleName)
                         throws IllegalArgumentException 

관계내의 지정된 MBean에 관련된 MBean를 취득합니다.

이것은 CIM Associator 및 AssociatorName 오퍼레이션에 대응합니다.

파라미터:

theMBeanName - MBean ObjectName

theRelTypeName - null도 가능. 지정했을 경우, 검색에서는 그 형태의 관계만이 고려된다. 그 외의 경우, 모든 관계형이 고려되는

theRoleName - null도 가능. 지정했을 경우, 그 롤내의 MBean가 참조되는 관계만이 고려된다. 그 외의 경우, 모든 롤이 고려된다

반환값:

HashMap. 키는 지정된 MBean에 관련된 MBean ObjectName. 각 키의 값은 키 MBean가 지정된 MBean에 관련된 관계의 관계 ID 로부터 완성되는 ArrayList (이것들은 복수가 다른 관계에 관련짓고 가능)

예외:

IllegalArgumentException - 파라미터가 null인 경우

findRelationsOfType

List  findRelationsOfType(String  theRelTypeName)
                         throws IllegalArgumentException,

                                RelationTypeNotFoundException 

지정된 형태의 관계의 관계 ID를 리턴합니다.

파라미터:

theRelTypeName - 관계형명

반환값:

관계 ID ArrayList

예외:

IllegalArgumentException - 파라미터가 null인 경우

RelationTypeNotFoundException - 그 이름의 관계형이 존재하지 않는 경우

getRole

List  getRole(String  theRelId,
             String  theRoleName)
             throws RelationServiceNotRegisteredException,

                    IllegalArgumentException,

                    RelationNotFoundException,

                    RoleNotFoundException 

지정된 관계에 포함되는 지정된 롤명의 롤치를 취득합니다.

파라미터:

theRelId - 관계 ID

theRoleName - 롤명

반환값:

롤값이 되는 ObjectName 객체의 ArrayList

예외:

RelationServiceNotRegisteredException - 관계 서비스가 미등록의 경우

IllegalArgumentException - 파라미터가 null인 경우

RelationNotFoundException - 지정된 ID에 대응하는 관계가 존재하지 않는 경우

RoleNotFoundException - 다음의 조건이 성립하는 경우:

- 지정된 이름의 롤이 존재하지 않는 경우

또는

- 롤이 읽어내 불가인 경우

관련 항목:

setRole(java.lang.String, javax.management.relation.Role)

getRoles

RoleResult  getRoles(String  theRelId,
                    String [] theRoleNameArray)
                    throws RelationServiceNotRegisteredException,

                           IllegalArgumentException,

                           RelationNotFoundException 

지정된 관계에 포함되는 지정된 이름의 롤의 값을 취득합니다.

파라미터:

theRelId - 관계 ID

theRoleNameArray - 취득되는 롤의 이름에서 완성되는 배열

반환값:

RoleResult 객체. 취득에 성공한 롤의 RoleList와 취득되지 않았던 롤의 RoleUnresolvedList를 포함한다

예외:

RelationServiceNotRegisteredException - 관계 서비스가 MBean Server에 등록되지 않은 경우

IllegalArgumentException - 파라미터가 null인 경우

RelationNotFoundException - 지정된 ID에 대응하는 관계가 존재하지 않는 경우

관련 항목:

setRoles(java.lang.String, javax.management.relation.RoleList)

getAllRoles

RoleResult  getAllRoles(String  theRelId)
                       throws IllegalArgumentException,

                              RelationNotFoundException,

                              RelationServiceNotRegisteredException 

관계에 포함되는 모든 롤을 리턴합니다.

파라미터:

theRelId - 관계 ID

반환값:

RoleResult 객체. 취득에 성공한 롤의 RoleList와 읽어낼 수 없었던 롤의 RoleUnresolvedList를 포함한다

예외:

IllegalArgumentException - 파라미터가 null인 경우

RelationNotFoundException - 지정된 ID에 대응하는 관계가 존재하지 않는 경우

RelationServiceNotRegisteredException - 관계 서비스가 MBean Server에 등록되지 않은 경우

getRoleCardinality

Integer  getRoleCardinality(String  theRelId,
                           String  theRoleName)
                           throws IllegalArgumentException,

                                  RelationNotFoundException,

                                  RoleNotFoundException 

지정된 롤내에서 현재 참조되고 있는 MBean 수를 취득합니다.

파라미터:

theRelId - 관계 ID

theRoleName - 롤명

반환값:

롤내의 현재 참조되고 있는 MBean 수

예외:

IllegalArgumentException - 파라미터가 null인 경우

RelationNotFoundException - 지정된 ID에 대응하는 관계가 존재하지 않는 경우

RoleNotFoundException - 지정된 이름의 롤이 존재하지 않는 경우

setRole

void setRole(String  theRelId,
             Role  theRole)
             throws RelationServiceNotRegisteredException,

                    IllegalArgumentException,

                    RelationNotFoundException,

                    RoleNotFoundException,

                    InvalidRoleValueException,

                    RelationTypeNotFoundException 

지정된 관계내의 지정된 롤을 설정합니다.

관계의 관계형에 포함되어 있는 대응하는 롤 정의에 따라, 롤을 체크합니다.

관계 서비스는 관계의 정합성을 확보하기 위해, 참조 대상의 MBean 등록 해제를 처리하는 것으로써, 변경을 추적합니다.

파라미터:

theRelId - 관계 ID

theRole - 설정되는 롤 (이름과 새로운 값)

예외:

RelationServiceNotRegisteredException - 관계 서비스가 MBean Server에 등록되지 않은 경우

IllegalArgumentException - 파라미터가 null인 경우

RelationNotFoundException - 지정된 ID에 대응하는 관계가 존재하지 않는 경우

RoleNotFoundException - 다음의 조건이 성립하는 경우:

- 내부 관계

또한

- 롤이 존재하지 않는지, 출력 불가

InvalidRoleValueException - 롤에 대해서 제공된 내부 관계 및 값이 무효인 경우:

- 지정된 값에 포함되는 참조 대상의 MBean 수가 예상 최소값보다 작은 경우

또는

- 지정된 값에 포함되는 참조 대상의 MBean 수가 예상 최대값을 넘고 있는 경우

또는

- 값에 포함되는 참조 대상의 MBean 중 1개이, 그 롤의 MBean 클래스의 객체가 아닌 경우

또는

- 그 롤의 MBean가 존재하지 않는 경우

RelationTypeNotFoundException - 미지의 관계형의 경우

관련 항목:

getRole(java.lang.String, java.lang.String)

setRoles

RoleResult  setRoles(String  theRelId,
                    RoleList  theRoleList)
                    throws RelationServiceNotRegisteredException,

                           IllegalArgumentException,

                           RelationNotFoundException 

지정된 관계내의 지정된 롤을 설정합니다.

관계의 관계형에 포함되어 있는 대응하는 롤 정의에 따라, 롤을 체크합니다.

관계 서비스는 관계의 정합성을 확보하기 위해, 참조 대상의 MBean 등록 해제를 처리하는 것으로써, 변경을 추적합니다.

파라미터:

theRelId - 관계 ID

theRoleList - 설정되는 롤의 리스트

반환값:

RoleResult 객체. 설정에 성공한 롤의 RoleList와 설정되지 않았던 롤의 RoleUnresolvedList를 포함한다

예외:

RelationServiceNotRegisteredException - 관계 서비스가 MBean Server에 등록되지 않은 경우

IllegalArgumentException - 파라미터가 null인 경우

RelationNotFoundException - 지정된 ID에 대응하는 관계가 존재하지 않는 경우

관련 항목:

getRoles(java.lang.String, java.lang.String[])

getReferencedMBeans

Map  getReferencedMBeans(String  theRelId)
                        throws IllegalArgumentException,

                               RelationNotFoundException 

관계의 다양한 롤로 참조되는 MBean를 취득합니다.

파라미터:

theRelId - 관계 ID

반환값:

HashMap 매핑:

ObjectName → String (롤명)로부터 완성되는 ArrayList

예외:

IllegalArgumentException - 파라미터가 null인 경우

RelationNotFoundException - 지정된 관계 ID에 대응하는 관계가 존재하지 않는 경우

getRelationTypeName

String  getRelationTypeName(String  theRelId)
                           throws IllegalArgumentException,

                                  RelationNotFoundException 

지정된 관계의 관계형의 이름을 리턴합니다.

파라미터:

theRelId - 관계 ID

반환값:

관련된 관계형의 이름

예외:

IllegalArgumentException - 파라미터가 null인 경우

RelationNotFoundException - 지정된 관계 ID에 대응하는 관계가 존재하지 않는 경우