public interface EntityManagement
Modifier and Type | Method and Description |
---|---|
pl.edu.icm.unity.types.basic.Identity |
addEntity(pl.edu.icm.unity.types.basic.IdentityParam toAdd,
String credReqIdId,
pl.edu.icm.unity.types.basic.EntityState initialState,
boolean extractAttributes)
As
addEntity(IdentityParam, String, EntityState, boolean, List) with the empty list of attributes. |
pl.edu.icm.unity.types.basic.Identity |
addEntity(pl.edu.icm.unity.types.basic.IdentityParam toAdd,
String credReqIdId,
pl.edu.icm.unity.types.basic.EntityState initialState,
boolean extractAttributes,
List<pl.edu.icm.unity.types.basic.Attribute> attributes)
Adds a new entity with an initial identity.
|
pl.edu.icm.unity.types.basic.Identity |
addIdentity(pl.edu.icm.unity.types.basic.IdentityParam toAdd,
pl.edu.icm.unity.types.basic.EntityParam parentEntity,
boolean extractAttributes)
Adds a new identity under existing entity.
|
pl.edu.icm.unity.types.basic.Entity |
getEntity(pl.edu.icm.unity.types.basic.EntityParam entity)
Returns information about an entity along with its all identities with authorization in '/'.
|
pl.edu.icm.unity.types.basic.Entity |
getEntity(pl.edu.icm.unity.types.basic.EntityParam entity,
String target,
boolean allowCreate,
String group)
Returns information about an entity along with its all identities.
|
String |
getEntityLabel(pl.edu.icm.unity.types.basic.EntityParam entity) |
pl.edu.icm.unity.types.basic.Entity |
getEntityNoContext(pl.edu.icm.unity.types.basic.EntityParam entity,
String group)
Returns information about an entity along with its identities.
|
Map<String,pl.edu.icm.unity.types.basic.GroupMembership> |
getGroups(pl.edu.icm.unity.types.basic.EntityParam entity)
Returns a collection with all groups where the entity is a member.
|
Collection<pl.edu.icm.unity.types.basic.Group> |
getGroupsForPresentation(pl.edu.icm.unity.types.basic.EntityParam entity)
Returns a collection with all groups where the entity is a member.
|
void |
mergeEntities(pl.edu.icm.unity.types.basic.EntityParam target,
pl.edu.icm.unity.types.basic.EntityParam merged,
boolean safeMode)
Merge the 2nd entity with the first one.
|
void |
removeEntity(pl.edu.icm.unity.types.basic.EntityParam toRemove)
Deletes entity.
|
void |
removeIdentity(pl.edu.icm.unity.types.basic.IdentityTaV toRemove)
Deletes identity.
|
void |
resetIdentity(pl.edu.icm.unity.types.basic.EntityParam entity,
String typeIdToReset,
String realm,
String target)
Reset a possibly targeted value of a dynamic identity.
|
void |
scheduleEntityChange(pl.edu.icm.unity.types.basic.EntityParam toChange,
Date changeTime,
pl.edu.icm.unity.types.basic.EntityScheduledOperation operation)
Schedules an operation to be invoked at a given time on an entity.
|
void |
scheduleRemovalByUser(pl.edu.icm.unity.types.basic.EntityParam toChange,
Date changeTime)
Sets the entity in the
EntityState.onlyLoginPermitted and schedules the entity removal at given
time unless the user logs in before this time. |
void |
setEntityStatus(pl.edu.icm.unity.types.basic.EntityParam toChange,
pl.edu.icm.unity.types.basic.EntityState state)
Sets entity status
|
void |
setIdentities(pl.edu.icm.unity.types.basic.EntityParam entity,
Collection<String> updatedTypes,
Collection<? extends pl.edu.icm.unity.types.basic.IdentityParam> newIdentities)
Updates identities of a single entity.
|
pl.edu.icm.unity.types.basic.Identity addEntity(pl.edu.icm.unity.types.basic.IdentityParam toAdd, String credReqIdId, pl.edu.icm.unity.types.basic.EntityState initialState, boolean extractAttributes, List<pl.edu.icm.unity.types.basic.Attribute> attributes) throws pl.edu.icm.unity.exceptions.EngineException
toAdd
- new identitycredReqId
- Local CredentialRequirements
idinitialState
- the initial state of the newly created entityextractAttributes
- whether automatic attributes extraction should be performedattributes
- initial attributes to be added for the entity. This is especially useful
when the root group (to which the entity is automatically added) has some AttributesClass
es assigned
with mandatory attributes.pl.edu.icm.unity.exceptions.EngineException
pl.edu.icm.unity.types.basic.Identity addEntity(pl.edu.icm.unity.types.basic.IdentityParam toAdd, String credReqIdId, pl.edu.icm.unity.types.basic.EntityState initialState, boolean extractAttributes) throws pl.edu.icm.unity.exceptions.EngineException
addEntity(IdentityParam, String, EntityState, boolean, List)
with the empty list of attributes.pl.edu.icm.unity.exceptions.EngineException
pl.edu.icm.unity.types.basic.Identity addIdentity(pl.edu.icm.unity.types.basic.IdentityParam toAdd, pl.edu.icm.unity.types.basic.EntityParam parentEntity, boolean extractAttributes) throws pl.edu.icm.unity.exceptions.EngineException
toAdd
- equivalentIdentity
- extractAttributes
- whether automatic attributes extraction should be performedpl.edu.icm.unity.exceptions.EngineException
void removeIdentity(pl.edu.icm.unity.types.basic.IdentityTaV toRemove) throws pl.edu.icm.unity.exceptions.EngineException
toRemove
- pl.edu.icm.unity.exceptions.EngineException
void setIdentities(pl.edu.icm.unity.types.basic.EntityParam entity, Collection<String> updatedTypes, Collection<? extends pl.edu.icm.unity.types.basic.IdentityParam> newIdentities) throws pl.edu.icm.unity.exceptions.EngineException
resetIdentity(EntityParam, String, String, String)
is available for them.entity
- all identities must belong to this entityupdatedTypes
- set of all types that shall be modifiednewIdentities
- a new, complete set of identities for the given typespl.edu.icm.unity.exceptions.EngineException
void resetIdentity(pl.edu.icm.unity.types.basic.EntityParam entity, String typeIdToReset, String realm, String target) throws pl.edu.icm.unity.exceptions.EngineException
entity
- subjecttypeIdToReset
- which id type should be reset, must be dynamicrealm
- if null then all realms should be clearedtarget
- if null then all targets should be clearedpl.edu.icm.unity.exceptions.EngineException
void removeEntity(pl.edu.icm.unity.types.basic.EntityParam toRemove) throws pl.edu.icm.unity.exceptions.EngineException
toRemove
- pl.edu.icm.unity.exceptions.EngineException
void setEntityStatus(pl.edu.icm.unity.types.basic.EntityParam toChange, pl.edu.icm.unity.types.basic.EntityState state) throws pl.edu.icm.unity.exceptions.EngineException
toChange
- state
- pl.edu.icm.unity.exceptions.EngineException
void scheduleEntityChange(pl.edu.icm.unity.types.basic.EntityParam toChange, Date changeTime, pl.edu.icm.unity.types.basic.EntityScheduledOperation operation) throws pl.edu.icm.unity.exceptions.EngineException
toChange
- changeTime
- operation
- pl.edu.icm.unity.exceptions.EngineException
void scheduleRemovalByUser(pl.edu.icm.unity.types.basic.EntityParam toChange, Date changeTime) throws pl.edu.icm.unity.exceptions.EngineException
EntityState.onlyLoginPermitted
and schedules the entity removal at given
time unless the user logs in before this time.
Requires only the attributeModify capability (allowed for selfAccess).toChange
- changeTime
- pl.edu.icm.unity.exceptions.EngineException
pl.edu.icm.unity.types.basic.Entity getEntity(pl.edu.icm.unity.types.basic.EntityParam entity) throws pl.edu.icm.unity.exceptions.EngineException
entity
- pl.edu.icm.unity.exceptions.EngineException
pl.edu.icm.unity.types.basic.Entity getEntity(pl.edu.icm.unity.types.basic.EntityParam entity, String target, boolean allowCreate, String group) throws pl.edu.icm.unity.exceptions.EngineException
entity
- who to resolvetarget
- for whom the information is targetedallowCreate
- whether dynamic identities can be createdgroup
- group wrt which authorization should be performed.pl.edu.icm.unity.exceptions.EngineException
pl.edu.icm.unity.types.basic.Entity getEntityNoContext(pl.edu.icm.unity.types.basic.EntityParam entity, String group) throws pl.edu.icm.unity.exceptions.EngineException
entity
- pl.edu.icm.unity.exceptions.EngineException
Map<String,pl.edu.icm.unity.types.basic.GroupMembership> getGroups(pl.edu.icm.unity.types.basic.EntityParam entity) throws pl.edu.icm.unity.exceptions.EngineException
entity
- pl.edu.icm.unity.exceptions.EngineException
Collection<pl.edu.icm.unity.types.basic.Group> getGroupsForPresentation(pl.edu.icm.unity.types.basic.EntityParam entity) throws pl.edu.icm.unity.exceptions.EngineException
entity
- pl.edu.icm.unity.exceptions.EngineException
void mergeEntities(pl.edu.icm.unity.types.basic.EntityParam target, pl.edu.icm.unity.types.basic.EntityParam merged, boolean safeMode) throws pl.edu.icm.unity.exceptions.EngineException
target
- merged
- pl.edu.icm.unity.exceptions.EngineException
String getEntityLabel(pl.edu.icm.unity.types.basic.EntityParam entity) throws pl.edu.icm.unity.exceptions.EngineException
entity
- pl.edu.icm.unity.exceptions.EngineException
Copyright © 2017 Unity. All rights reserved.