Package ch.ivyteam.ivy.security.member

Interface IMemberRepository

public interface IMemberRepository
Security member repository to find security members

Example:


 ISecurityMember member = ivy.security.members().find("#Ivy");
Since:
9.3
API:
This is a public API.

  • Method Summary

    Modifier and Type
    Method
    Description
    ISecurityMember
    find(String securityMemberName)
    Finds a security member with its name.
    ISecurityMember
    findById(String securityMemberId)
    Finds a security member with its security member id.

  • Method Details

    • find

      ISecurityMember find(String securityMemberName)

      Finds a security member with its name.

      Example:

      
 ISecurityMember member = ivy.security.members().find("#Ivy");
      Parameters:
      securityMemberName - the security member name
      Returns:
      the security member found or null.
      Throws:
      PersistencyException - if persistency access fails
      See Also:
      API:
      This public API is available in IvyScript and Java. It has the visibility NOVICE.

    • findById

      ISecurityMember findById(String securityMemberId)

      Finds a security member with its security member id.

      Example:

      
 ISecurityMember member = ivy.security.members().findById("ROLE-XYZ");
      Parameters:
      securityMemberId - the security member ID
      Returns:
      the security member found or null.
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in IvyScript and Java. It has the visibility NOVICE.