Package org.opensaml.security.criteria

Class PeerEntityIDCriterion

java.lang.Object
org.opensaml.security.criteria.PeerEntityIDCriterion
All Implemented Interfaces:
Criterion
@Deprecated(since="5.3.0", forRemoval=true) public final class PeerEntityIDCriterion extends Object implements Criterion
Deprecated, for removal: This API element is subject to removal in a future version.
An implementation of Criterion which specifies criteria pertaining to peer entity IDs. This is typically used only in conjunction with a EntityIdCriterion, where the peer is interpreted to be relative to that primary entity ID. In this sense it serves to scope the primary entity ID. Note that the peer entity ID may be either local or remote, depending on whether the associated primary entity ID is remote or local.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private String
    peerID
    Deprecated, for removal: This API element is subject to removal in a future version.
    Peer entity ID criteria.

  • Constructor Summary

    Constructors
    Constructor
    Description
    PeerEntityIDCriterion(String peer)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
    Deprecated, for removal: This API element is subject to removal in a future version.
    String
    getPeerID()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get the entity ID which is the peer relative to a primary entity ID.
    int
    hashCode()
    Deprecated, for removal: This API element is subject to removal in a future version.
    void
    setPeerID(String peer)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Set the entity ID which is the peer relative to a primary entity ID.
    String
    toString()
    Deprecated, for removal: This API element is subject to removal in a future version.
    String
    validatePeerID(String peer)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Validate peer ID criterion.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • peerID

      @Nonnull @NotEmpty private String peerID
      Deprecated, for removal: This API element is subject to removal in a future version.
      Peer entity ID criteria.

  • Constructor Details

    • PeerEntityIDCriterion

      public PeerEntityIDCriterion(@Nonnull @NotEmpty String peer)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Constructor.
      Parameters:
      peer - the entity ID which is the peer relative to a primary entity ID

  • Method Details

    • getPeerID

      @Nonnull @NotEmpty public String getPeerID()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the entity ID which is the peer relative to a primary entity ID.
      Returns:
      the peer entity ID.

    • setPeerID

      public void setPeerID(@Nonnull @NotEmpty String peer)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set the entity ID which is the peer relative to a primary entity ID.
      Parameters:
      peer - The peerID to set.

    • toString

      public String toString()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      toString in class Object

    • hashCode

      public int hashCode()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      equals in class Object

    • validatePeerID

      @Nonnull @NotEmpty public String validatePeerID(@Nonnull @NotEmpty String peer)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Validate peer ID criterion.
      Parameters:
      peer - ID to check
      Returns:
      the input if non-null/empty