Класс 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, если параметр name одного из методов 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 — прежнее значение роли (список объектов ObjectName)

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

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

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

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

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

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

Параметры:

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

unregMBeanList — список 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 — прежнее значение роли (список объектов 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 Server

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 Server

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

Указано в:

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

Параметры:

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

roleName - имя роли

Возвращает:

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

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

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

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

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

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

Указано в:

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

Параметры:

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

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

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

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

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

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

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

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

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

или

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

или

- один из MBean, на которые ссылается значение, не является объектом ожидаемого для этой роли класса 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 Server

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

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

См. также:

• getRoles(String, String[])

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

Указано в:

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

Параметры:

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

Возвращает:

HashMap, сопоставляющий:

ObjectName -> ArrayList String (имён ролей)

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

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

Возвращает:

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