Package swiss.trustbroker.federation.xmlconfig

Class IdmQuery

java.lang.Object
swiss.trustbroker.federation.xmlconfig.IdmQuery
All Implemented Interfaces:
Serializable, swiss.trustbroker.api.idm.dto.IdmRequest
public class IdmQuery extends Object implements Serializable, swiss.trustbroker.api.idm.dto.IdmRequest
Configures an IDM query to be executed.
See Also:

  • Constructor Details

    • IdmQuery

      public IdmQuery()

    • IdmQuery

      public IdmQuery(Integer order, String id, String name, String store, String issuerNameId, String issuerNameIdNS, StatusPolicy statusPolicy, String clientExtId, String subjectNameId, String appFilter, String subResource, AttributesSelection userDetailsSelection, boolean sortByName)
      Creates a new IdmQuery instance.
      Parameters:
      order - The order of the execution of the query.
      id - A query needs an ID when its name is not unique and its execution needs to be controlled via a custom script based on CP input usually.
      name - Name of the query, depending on the IdmService implementation.
      store - Used to select an IdmService implementation
      issuerNameId - SAML federation filter to be applied to the user query.
      issuerNameIdNS - Instead of an issuerNameId the SAML federation can also be identified via its fully qualified homeName attribute as an input.
      statusPolicy - Handling of the user status in IDM.
      clientExtId - Client External ID (tenant) as filtering parameter for the IDM.
      subjectNameId - Subject Name ID as filtering parameter for the IDM.
      appFilter - Application as filtering parameter for the IDM.
      subResource - Sub resource parameter for the IDM (baseDN in case of LDAP).
      userDetailsSelection - User details selection identifies the IDM attributes passed through to the RP side.
      sortByName -
      Since:
      1.15.0, 1.10.0, 1.13.0

  • Method Details

    • statusPolicyWithDefault

      public StatusPolicy statusPolicyWithDefault()

    • isFetchActiveOnly

      public boolean isFetchActiveOnly()
      Specified by:
      isFetchActiveOnly in interface swiss.trustbroker.api.idm.dto.IdmRequest

    • getAttributeSelection

      public List<swiss.trustbroker.api.sessioncache.dto.AttributeName> getAttributeSelection()
      Specified by:
      getAttributeSelection in interface swiss.trustbroker.api.idm.dto.IdmRequest

    • getUserStatusPolicy

      public String getUserStatusPolicy()
      Specified by:
      getUserStatusPolicy in interface swiss.trustbroker.api.idm.dto.IdmRequest

    • getIssuerNameIdAttribute

      public swiss.trustbroker.api.sessioncache.dto.AttributeName getIssuerNameIdAttribute()
      Specified by:
      getIssuerNameIdAttribute in interface swiss.trustbroker.api.idm.dto.IdmRequest

    • getSubjectNameIdAttribute

      public swiss.trustbroker.api.sessioncache.dto.AttributeName getSubjectNameIdAttribute()
      Specified by:
      getSubjectNameIdAttribute in interface swiss.trustbroker.api.idm.dto.IdmRequest

    • of

      public static IdmQuery of(swiss.trustbroker.api.idm.dto.IdmRequest idmRequest)

    • builder

      public static IdmQuery.IdmQueryBuilder builder()

    • getOrder

      public Integer getOrder()
      The order of the execution of the query.
      Specified by:
      getOrder in interface swiss.trustbroker.api.idm.dto.IdmRequest
      Since:
      1.15.0

    • getId

      public String getId()
      A query needs an ID when its name is not unique and its execution needs to be controlled via a custom script based on CP input usually.
      Specified by:
      getId in interface swiss.trustbroker.api.idm.dto.IdmRequest

    • getName

      public String getName()
      Name of the query, depending on the IdmService implementation.
      Specified by:
      getName in interface swiss.trustbroker.api.idm.dto.IdmRequest

    • getStore

      public String getStore()
      Used to select an IdmService implementation
      Specified by:
      getStore in interface swiss.trustbroker.api.idm.dto.IdmRequest
      Since:
      1.10.0

    • getIssuerNameId

      public String getIssuerNameId()
      SAML federation filter to be applied to the user query.

    • getIssuerNameIdNS

      public String getIssuerNameIdNS()
      Instead of an issuerNameId the SAML federation can also be identified via its fully qualified homeName attribute as an input.

    • getStatusPolicy

      public StatusPolicy getStatusPolicy()
      Handling of the user status in IDM.

    • getClientExtId

      public String getClientExtId()
      Client External ID (tenant) as filtering parameter for the IDM.
      Specified by:
      getClientExtId in interface swiss.trustbroker.api.idm.dto.IdmRequest

    • getSubjectNameId

      public String getSubjectNameId()
      Subject Name ID as filtering parameter for the IDM.

    • getAppFilter

      public String getAppFilter()
      Application as filtering parameter for the IDM.
      Specified by:
      getAppFilter in interface swiss.trustbroker.api.idm.dto.IdmRequest

    • getSubResource

      public String getSubResource()
      Sub resource parameter for the IDM (baseDN in case of LDAP).
      Specified by:
      getSubResource in interface swiss.trustbroker.api.idm.dto.IdmRequest
      Since:
      1.13.0

    • getUserDetailsSelection

      public AttributesSelection getUserDetailsSelection()
      User details selection identifies the IDM attributes passed through to the RP side.

    • isSortByName

      public boolean isSortByName()

    • setOrder

      public void setOrder(Integer order)
      The order of the execution of the query.
      Since:
      1.15.0

    • setId

      public void setId(String id)
      A query needs an ID when its name is not unique and its execution needs to be controlled via a custom script based on CP input usually.

    • setName

      public void setName(String name)
      Name of the query, depending on the IdmService implementation.

    • setStore

      public void setStore(String store)
      Used to select an IdmService implementation
      Since:
      1.10.0

    • setIssuerNameId

      public void setIssuerNameId(String issuerNameId)
      SAML federation filter to be applied to the user query.

    • setIssuerNameIdNS

      public void setIssuerNameIdNS(String issuerNameIdNS)
      Instead of an issuerNameId the SAML federation can also be identified via its fully qualified homeName attribute as an input.

    • setStatusPolicy

      public void setStatusPolicy(StatusPolicy statusPolicy)
      Handling of the user status in IDM.

    • setClientExtId

      public void setClientExtId(String clientExtId)
      Client External ID (tenant) as filtering parameter for the IDM.

    • setSubjectNameId

      public void setSubjectNameId(String subjectNameId)
      Subject Name ID as filtering parameter for the IDM.

    • setAppFilter

      public void setAppFilter(String appFilter)
      Application as filtering parameter for the IDM.

    • setSubResource

      public void setSubResource(String subResource)
      Sub resource parameter for the IDM (baseDN in case of LDAP).
      Since:
      1.13.0

    • setUserDetailsSelection

      public void setUserDetailsSelection(AttributesSelection userDetailsSelection)
      User details selection identifies the IDM attributes passed through to the RP side.

    • setSortByName

      public void setSortByName(boolean sortByName)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object