Interface IdTypeService
-
public interface IdTypeServiceAllows performing operations related toIdType
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description IdTypegetType(String type)Returns anIdTypegiven a type.voidreloadTypeCache()Causes the IdType related configuration to be reloaded from the config store.Set<IdType>typesWhichCanAddMember(IdType type)Returns the types which have the provided type added as a member.Set<IdType>typesWhichCanBeMembersOf(IdType type)Returns the types which can be a member of the provided type.Set<IdType>typesWhichCanHaveMember(IdType type)Returns the types which have the provided type as a member.
-
-
-
Method Detail
-
typesWhichCanBeMembersOf
Set<IdType> typesWhichCanBeMembersOf(IdType type)
Returns the types which can be a member of the provided type. For example, a USER might be able to be a member of a GROUP.- Parameters:
type- The type to return information on- Returns:
- The types which can be members of the provided type
-
typesWhichCanHaveMember
Set<IdType> typesWhichCanHaveMember(IdType type)
Returns the types which have the provided type as a member. For example, a GROUP might be able to have a USER as a member.- Parameters:
type- The type to return information on- Returns:
- The types which have the provided type as a member
-
typesWhichCanAddMember
Set<IdType> typesWhichCanAddMember(IdType type)
Returns the types which have the provided type added as a member. For example, a GROUP might be able to have a USER added as a member, but a FILTEREDROLE might not, even if a USER can be a member of a FILTEREDROLE.- Parameters:
type- The type to return information on- Returns:
- The types which have the provided type added as a member
-
reloadTypeCache
void reloadTypeCache()
Causes the IdType related configuration to be reloaded from the config store. This may be useful if the configuration failed to load originally, and default configuration was loaded instead.
-
getType
IdType getType(String type) throws IdRepoException
Returns anIdTypegiven a type.- Parameters:
type- the name of the type- Returns:
- the corresponding IdType
- Throws:
IdRepoException- if there are no corresponding types.
-
-