Класс RelationService

public RelationService(boolean immediatePurgeFlag)

Параметры:

immediatePurgeFlag — флаг, указывающий, нужно ли немедленно выполнять «очистку» связей (искать связи, утратившие актуальность) при получении уведомления об отмене регистрации MBean, на который ссылается связь, или же это будет выполнено только при явном вызове метода purgeRelations.

true означает немедленную очистку.

public void isActive() throws RelationServiceNotRegisteredException

Определено в:

isActive в интерфейсе RelationServiceMBean

Вызывает исключение:

RelationServiceNotRegisteredException — если она не зарегистрирована

public ObjectName preRegister(MBeanServer server, ObjectName name) throws Exception

Определено в:

preRegister в интерфейсе MBeanRegistration

Параметры:

server — сервер MBean, на котором будет зарегистрирован MBean.

name — имя объекта MBean. Это имя равно null, если параметр имени в одном из методов createMBean или registerMBean интерфейса MBeanServer равен null. В этом случае данный метод должен вернуть ненулевое имя ObjectName для нового MBean.

Возвращает:

Имя, под которым должен быть зарегистрирован MBean. Это значение не должно быть null. Если параметр name не равен null, обычно, но не обязательно, возвращается именно это значение.

Вызывает исключение:

Exception — это исключение будет перехвачено сервером MBean и повторно выброшено как MBeanRegistrationException.

public void postRegister(Boolean registrationDone)

Определено в:

postRegister в интерфейсе MBeanRegistration

Параметры:

registrationDone — указывает, был ли MBean успешно зарегистрирован на сервере MBean. Значение false означает, что этап регистрации завершился неудачно.

public void preDeregister() throws Exception

Определено в:

preDeregister в интерфейсе MBeanRegistration

Вызывает исключение:

Exception — это исключение будет перехвачено сервером MBean и повторно выброшено как MBeanRegistrationException.

public void postDeregister()

Определено в:

postDeregister в интерфейсе MBeanRegistration

public boolean getPurgeFlag()

Определено в:

getPurgeFlag в интерфейсе RelationServiceMBean

Возвращает:

true, если очистка выполняется автоматически.

См. также:

• setPurgeFlag(boolean)

public void setPurgeFlag(boolean purgeFlag)

Определено в:

setPurgeFlag в интерфейсе RelationServiceMBean

Параметры:

purgeFlag — флаг

См. также:

• getPurgeFlag()

public void createRelationType(String relationTypeName, RoleInfo[] roleInfoArray) throws IllegalArgumentException, InvalidRelationTypeException

Определено в:

createRelationType в интерфейсе RelationServiceMBean

Параметры:

relationTypeName — имя типа связи

roleInfoArray — массив сведений о ролях

Вызывает исключение:

IllegalArgumentException — если параметр равен null

InvalidRelationTypeException — если:

— тип связи с таким именем уже существует

— одно и то же имя использовано для двух разных сведений о ролях

— сведения о ролях не предоставлены

— одно из сведений о ролях равно null

public void addRelationType(RelationType relationTypeObj) throws IllegalArgumentException, InvalidRelationTypeException

Определено в:

addRelationType в интерфейсе RelationServiceMBean

Параметры:

relationTypeObj — объект типа связи (реализующий интерфейс RelationType)

Вызывает исключение:

IllegalArgumentException — если параметр равен null или relationTypeObj.getRelationTypeName() возвращает null.

InvalidRelationTypeException — если:

— одно и то же имя использовано для двух разных ролей

— сведения о ролях не предоставлены

— одно из сведений о ролях равно null

— тип связи с таким именем уже существует

public List<String> getAllRelationTypeNames()

Определено в:

getAllRelationTypeNames в интерфейсе RelationServiceMBean

Возвращает:

ArrayList с именами типов связей (String)

public List<RoleInfo> getRoleInfos(String relationTypeName) throws IllegalArgumentException, RelationTypeNotFoundException

Определено в:

getRoleInfos в интерфейсе RelationServiceMBean

Параметры:

relationTypeName — имя типа связи

Возвращает:

ArrayList объектов RoleInfo.

Вызывает исключение:

IllegalArgumentException — если параметр равен null

RelationTypeNotFoundException — если типа связи с таким именем не существует.

public RoleInfo getRoleInfo(String relationTypeName, String roleInfoName) throws IllegalArgumentException, RelationTypeNotFoundException, RoleInfoNotFoundException

Определено в:

getRoleInfo в интерфейсе RelationServiceMBean

Параметры:

relationTypeName — имя типа связи

roleInfoName — имя роли

Возвращает:

Объект RoleInfo.

Вызывает исключение:

IllegalArgumentException — если параметр равен null

RelationTypeNotFoundException — если тип связи неизвестен службе связей

RoleInfoNotFoundException — если роль не входит в состав типа связи.

public void removeRelationType(String relationTypeName) throws RelationServiceNotRegisteredException, IllegalArgumentException, RelationTypeNotFoundException

Определено в:

removeRelationType в интерфейсе RelationServiceMBean

Параметры:

relationTypeName — имя удаляемого типа связи

Вызывает исключение:

RelationServiceNotRegisteredException — если служба связей не зарегистрирована на сервере MBean

IllegalArgumentException — если параметр равен null

RelationTypeNotFoundException — если типа связи с таким именем не существует

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

Определено в:

createRelation в интерфейсе RelationServiceMBean

Параметры:

relationId — идентификатор связи, уникально идентифицирующий связь в службе связей

relationTypeName — имя типа связи (тип должен быть создан в службе связей)

roleList — список ролей для инициализации ролей связи (может быть null).

Вызывает исключение:

RelationServiceNotRegisteredException — если служба связей не зарегистрирована на сервере MBean

IllegalArgumentException — если параметр равен null, за исключением списка ролей, который может быть null, если роли не нужно инициализировать

RoleNotFoundException — если для роли задано значение, но такая роль отсутствует в типе связи

InvalidRelationIdException — если идентификатор связи уже используется

RelationTypeNotFoundException — если тип связи неизвестен службе связей

InvalidRoleValueException — если:

— одно и то же имя использовано для двух разных ролей

— количество ссылающихся MBean в заданном значении меньше ожидаемой минимальной степени

— количество ссылающихся MBean в заданном значении превышает ожидаемую максимальную степень

— один из ссылающихся MBean в значении не является объектом класса MBean, ожидаемого для этой роли

— MBean, указанный для этой роли, не существует

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

Определено в:

addRelation в интерфейсе RelationServiceMBean

Параметры:

relationObjectName — ObjectName добавляемого MBean-связи.

Вызывает исключение:

IllegalArgumentException — если параметр равен null

RelationServiceNotRegisteredException — если служба связей не зарегистрирована на сервере MBean

NoSuchMethodException — если MBean не реализует интерфейс Relation

InvalidRelationIdException — если:

— в MBean отсутствует идентификатор связи

— идентификатор связи уже используется в службе связей

InstanceNotFoundException — если MBean с заданным ObjectName не зарегистрирован

InvalidRelationServiceException — если:

— в MBean не указано имя службы связей

— имя службы связей в MBean не совпадает с именем текущей службы связей

RelationTypeNotFoundException — если:

— в MBean не указано имя типа связи

— имя типа связи в MBean не соответствует типу связи, созданному в службе связей

InvalidRoleValueException — если:

— количество ссылающихся MBean в роли меньше ожидаемой минимальной степени

— количество ссылающихся MBean в роли превышает ожидаемую максимальную степень

— один из ссылающихся MBean в значении не является объектом класса MBean, ожидаемого для этой роли

— MBean, указанный для роли, не существует

RoleNotFoundException — если для роли задано значение, но такая роль отсутствует в типе связи

public ObjectName isRelationMBean(String relationId) throws IllegalArgumentException, RelationNotFoundException

Определено в:

isRelationMBean в интерфейсе RelationServiceMBean

Параметры:

relationId — идентификатор связи

Возвращает:

ObjectName соответствующего MBean-связи или null, если связь не является MBean.

Вызывает исключение:

IllegalArgumentException — если параметр равен null

RelationNotFoundException — если связь с таким идентификатором отсутствует

public String isRelation(ObjectName objectName) throws IllegalArgumentException

Определено в:

isRelation в интерфейсе RelationServiceMBean

Параметры:

objectName — ObjectName предполагаемой связи

Возвращает:

идентификатор связи (String) или null (если ObjectName не является связью, обрабатываемой службой связей)

Вызывает исключение:

IllegalArgumentException — если параметр равен null

public Boolean hasRelation(String relationId) throws IllegalArgumentException

Определено в:

hasRelation в интерфейсе RelationServiceMBean

Параметры:

relationId — идентификатор связи

Возвращает:

boolean: true, если связь существует, иначе false

Вызывает исключение:

IllegalArgumentException — если параметр равен null

public List<String> getAllRelationIds()

Определено в:

getAllRelationIds в интерфейсе RelationServiceMBean

Возвращает:

ArrayList объектов String

public Integer checkRoleReading(String roleName, String relationTypeName) throws IllegalArgumentException, RelationTypeNotFoundException

Определено в:

checkRoleReading в интерфейсе RelationServiceMBean

Параметры:

roleName — имя проверяемой роли

relationTypeName — имя типа связи

Возвращает:

Integer, содержащий целое число, соответствующее возможной проблеме, представленной константой в RoleUnresolved:

— 0, если роль можно прочитать

— целое число, соответствующее RoleStatus.NO_ROLE_WITH_NAME

— целое число, соответствующее RoleStatus.ROLE_NOT_READABLE

Вызывает исключение:

IllegalArgumentException — если параметр равен null

RelationTypeNotFoundException — если тип связи неизвестен службе связей

public Integer checkRoleWriting(Role role, String relationTypeName, Boolean initFlag) throws IllegalArgumentException, RelationTypeNotFoundException

Определено в:

checkRoleWriting в интерфейсе RelationServiceMBean

Параметры:

role — проверяемая роль

relationTypeName — имя типа связи

initFlag — флаг, указывающий, что проверка выполняется при инициализации роли; проверять доступ на запись не требуется.

Возвращает:

Integer, содержащий целое число, соответствующее возможной проблеме, представленной константой в RoleUnresolved:

— 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 — если тип связи неизвестен

public void sendRelationCreationNotification(String relationId) throws IllegalArgumentException, RelationNotFoundException

Определено в:

sendRelationCreationNotification в интерфейсе RelationServiceMBean

Параметры:

relationId — идентификатор обновленной связи

Вызывает исключение:

IllegalArgumentException — если параметр равен null

RelationNotFoundException — если связи с заданным идентификатором не существует

public void sendRoleUpdateNotification(String relationId, Role newRole, List<ObjectName> oldValue) throws IllegalArgumentException, RelationNotFoundException

Определено в:

sendRoleUpdateNotification в интерфейсе RelationServiceMBean

Параметры:

relationId — идентификатор обновленной связи

newRole — новая роль (имя и новое значение)

oldValue — старое значение роли (List объектов ObjectName)

Вызывает исключение:

IllegalArgumentException — если параметр равен null

RelationNotFoundException — если связи с заданным идентификатором не существует

public void sendRelationRemovalNotification(String relationId, List<ObjectName> unregMBeanList) throws IllegalArgumentException, RelationNotFoundException

Определено в:

sendRelationRemovalNotification в интерфейсе RelationServiceMBean

Параметры:

relationId — идентификатор обновленной связи

unregMBeanList — List объектов ObjectName для MBean, регистрацию которых предполагается отменить из-за удаления связи (может быть null)

Вызывает исключение:

IllegalArgumentException — если параметр равен null

RelationNotFoundException — если связи с заданным идентификатором не существует

public void updateRoleMap(String relationId, Role newRole, List<ObjectName> oldValue) throws IllegalArgumentException, RelationServiceNotRegisteredException, RelationNotFoundException

Определено в:

updateRoleMap в интерфейсе RelationServiceMBean

Параметры:

relationId — идентификатор обновленной связи

newRole — новая роль (имя и новое значение)

oldValue — старое значение роли (List объектов ObjectName)

Вызывает исключение:

IllegalArgumentException — если параметр равен null

RelationServiceNotRegisteredException — если служба связей не зарегистрирована на сервере MBean

RelationNotFoundException — если связи с заданным идентификатором не существует.

public void removeRelation(String relationId) throws RelationServiceNotRegisteredException, IllegalArgumentException, RelationNotFoundException

Определено в:

removeRelation в интерфейсе RelationServiceMBean

Параметры:

relationId — идентификатор удаляемой связи

Вызывает исключение:

RelationServiceNotRegisteredException — если служба связей не зарегистрирована на сервере MBean

IllegalArgumentException — если параметр равен null

RelationNotFoundException — если связи с заданным идентификатором не существует

public void purgeRelations() throws RelationServiceNotRegisteredException

Определено в:

purgeRelations в интерфейсе RelationServiceMBean

Вызывает исключение:

RelationServiceNotRegisteredException — если служба связей не зарегистрирована на сервере MBean.

public Map<String, List<String>> findReferencingRelations(ObjectName mbeanName, String relationTypeName, String roleName) throws IllegalArgumentException

Указано в:

findReferencingRelations в интерфейсе RelationServiceMBean

Параметры:

mbeanName - ObjectName объекта MBean

relationTypeName - может быть null; если указано, при поиске будут рассматриваться только отношения этого типа. В противном случае рассматриваются все типы отношений.

roleName - может быть null; если указано, будут возвращены только отношения, в которых MBean является объектом ссылки в этой роли. В противном случае рассматриваются все роли.

Возвращает:

HashMap, в котором ключами являются идентификаторы отношений, где MBean является объектом ссылки, а значением для каждого ключа — ArrayList имён ролей (поскольку один MBean может быть объектом ссылки в нескольких ролях одного отношения).

Вызывает исключения:

IllegalArgumentException - если параметр равен null

public Map<ObjectName, List<String>> findAssociatedMBeans(ObjectName mbeanName, String relationTypeName, String roleName) throws IllegalArgumentException

Указано в:

findAssociatedMBeans в интерфейсе RelationServiceMBean

Параметры:

mbeanName - ObjectName объекта MBean

relationTypeName - может быть null; если указано, при поиске будут рассматриваться только отношения этого типа. В противном случае рассматриваются все типы отношений.

roleName - может быть null; если указано, будут рассматриваться только отношения, в которых MBean является объектом ссылки в этой роли. В противном случае рассматриваются все роли.

Возвращает:

HashMap, в котором ключами являются ObjectName объектов MBean, связанных с указанным MBean, а значением для каждого ключа — ArrayList идентификаторов отношений, в которых MBean, соответствующий ключу, связан с указанным MBean (поскольку они могут быть связаны в нескольких разных отношениях).

Вызывает исключения:

IllegalArgumentException - если параметр равен null

public List<String> findRelationsOfType(String relationTypeName) throws IllegalArgumentException, RelationTypeNotFoundException

Указано в:

findRelationsOfType в интерфейсе RelationServiceMBean

Параметры:

relationTypeName - имя типа отношения

Возвращает:

ArrayList идентификаторов отношений.

Вызывает исключения:

IllegalArgumentException - если параметр равен null

RelationTypeNotFoundException - если типа отношения с таким именем не существует.

public List<ObjectName> getRole(String relationId, String roleName) throws RelationServiceNotRegisteredException, IllegalArgumentException, RelationNotFoundException, RoleNotFoundException

Указано в:

getRole в интерфейсе RelationServiceMBean

Параметры:

relationId - идентификатор отношения

roleName - имя роли

Возвращает:

ArrayList объектов ObjectName, представляющий значение роли

Вызывает исключения:

RelationServiceNotRegisteredException - если служба отношений не зарегистрирована

IllegalArgumentException - если параметр равен null

RelationNotFoundException - если отношения с указанным идентификатором не существует

RoleNotFoundException - если:

- роли с указанным именем не существует

или

- роль недоступна для чтения.

См. также:

• setRole(String, Role)

public RoleResult getRoles(String relationId, String[] roleNameArray) throws RelationServiceNotRegisteredException, IllegalArgumentException, RelationNotFoundException

Указано в:

getRoles в интерфейсе RelationServiceMBean

Параметры:

relationId - идентификатор отношения

roleNameArray - массив имён ролей, значения которых требуется получить

Возвращает:

объект RoleResult, содержащий RoleList (для успешно полученных ролей) и RoleUnresolvedList (для ролей, значения которых получить не удалось).

Вызывает исключения:

RelationServiceNotRegisteredException - если служба отношений не зарегистрирована на сервере MBean

IllegalArgumentException - если параметр равен null

RelationNotFoundException - если отношения с указанным идентификатором не существует

См. также:

• setRoles(String, RoleList)

public RoleResult getAllRoles(String relationId) throws IllegalArgumentException, RelationNotFoundException, RelationServiceNotRegisteredException

Указано в:

getAllRoles в интерфейсе RelationServiceMBean

Параметры:

relationId - идентификатор отношения

Возвращает:

объект RoleResult, содержащий RoleList (для успешно полученных ролей) и RoleUnresolvedList (для ролей, недоступных для чтения).

Вызывает исключения:

IllegalArgumentException - если параметр равен null

RelationNotFoundException - если отношения с указанным идентификатором не существует

RelationServiceNotRegisteredException - если служба отношений не зарегистрирована на сервере MBean

public Integer getRoleCardinality(String relationId, String roleName) throws IllegalArgumentException, RelationNotFoundException, RoleNotFoundException

Указано в:

getRoleCardinality в интерфейсе RelationServiceMBean

Параметры:

relationId - идентификатор отношения

roleName - имя роли

Возвращает:

количество MBeans, на которые в данный момент ссылается эта роль

Вызывает исключения:

IllegalArgumentException - если параметр равен null

RelationNotFoundException - если отношения с указанным идентификатором не существует

RoleNotFoundException - если роли с указанным именем не существует

public void setRole(String relationId, Role role) throws RelationServiceNotRegisteredException, IllegalArgumentException, RelationNotFoundException, RoleNotFoundException, InvalidRoleValueException

Указано в:

setRole в интерфейсе RelationServiceMBean

Параметры:

relationId - идентификатор отношения

role - задаваемая роль (имя и новое значение)

Вызывает исключения:

RelationServiceNotRegisteredException - если служба отношений не зарегистрирована на сервере MBean

IllegalArgumentException - если параметр равен null

RelationNotFoundException - если отношения с указанным идентификатором не существует

RoleNotFoundException - если роль не существует или недоступна для записи

InvalidRoleValueException - если заданное для роли значение недопустимо:

- количество MBeans, на которые ссылается заданное значение, меньше ожидаемой минимальной степени

или

- количество MBeans, на которые ссылается заданное значение, превышает ожидаемую максимальную степень

или

- один из указанных в значении MBeans не является объектом ожидаемого для этой роли класса MBean

или

- указанный для этой роли MBean не существует

См. также:

• getRole(String, String)

public RoleResult setRoles(String relationId, RoleList roleList) throws RelationServiceNotRegisteredException, IllegalArgumentException, RelationNotFoundException

Указано в:

setRoles в интерфейсе RelationServiceMBean

Параметры:

relationId - идентификатор отношения

roleList - список задаваемых ролей

Возвращает:

объект RoleResult, содержащий RoleList (для успешно заданных ролей) и RoleUnresolvedList (для ролей, которые задать не удалось).

Вызывает исключения:

RelationServiceNotRegisteredException - если служба отношений не зарегистрирована на сервере MBean

IllegalArgumentException - если параметр равен null

RelationNotFoundException - если отношения с указанным идентификатором не существует

См. также:

• getRoles(String, String[])

public Map<ObjectName, List<String>> getReferencedMBeans(String relationId) throws IllegalArgumentException, RelationNotFoundException

Указано в:

getReferencedMBeans в интерфейсе RelationServiceMBean

Параметры:

relationId - идентификатор отношения

Возвращает:

HashMap, содержащий соответствия:

ObjectName -> ArrayList строк (имена ролей)

Вызывает исключения:

IllegalArgumentException - если параметр равен null

RelationNotFoundException - если отношения с указанным идентификатором не существует

public String getRelationTypeName(String relationId) throws IllegalArgumentException, RelationNotFoundException

Указано в:

getRelationTypeName в интерфейсе RelationServiceMBean

Параметры:

relationId - идентификатор отношения

Возвращает:

имя связанного типа отношения.

Вызывает исключения:

IllegalArgumentException - если параметр равен null

RelationNotFoundException - если отношения с указанным идентификатором не существует

public void handleNotification(Notification notif, Object handback)

Указано в:

handleNotification в интерфейсе NotificationListener

Параметры:

notif - уведомление.

handback - непрозрачный объект, который помогает слушателю связать сведения об источнике MBean (может быть null).

public MBeanNotificationInfo[] getNotificationInfo()

Указано в:

getNotificationInfo в интерфейсе NotificationBroadcaster

Возвращает:

массив возможных уведомлений.