Package ddf.catalog.util.impl

Class Masker

java.lang.Object
ddf.catalog.util.impl.Masker
public class Masker extends Object
A utility used to mask the source ID for all maskable items that have their own name (ID). Masker enables DDF to specify a single name, the DDF's site name as specified in the DDF System Settings, for the site name in all responses from connected sources and catalog providers, which are both maskable items.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected List<ddf.catalog.util.Maskable>
    maskees
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    Masker()
    Creates an empty list of Maskable services that this Masker will internally maintain.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    bind(ddf.catalog.util.Maskable masked)
    Called by blueprint when a service is bound, this method sets the ID of the newly bound Maskable service to the masked ID if the mask ID has been previously set, and adds the new service to the internally maintained list of Maskable services.
    void
    setId(String id)
    Set the id of all Maskable sources to be the specified input ID.
    void
    unbind(ddf.catalog.util.Maskable masked)
    Called by blueprint when a service is unbound, this method removes the unbound service from the list of Maskable sources maintained internally by this Masker.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • maskees

      protected List<ddf.catalog.util.Maskable> maskees

  • Constructor Details

    • Masker

      public Masker()
      Creates an empty list of Maskable services that this Masker will internally maintain.

  • Method Details

    • setId

      public void setId(String id)
      Set the id of all Maskable sources to be the specified input ID. Once this masked ID is set it cannot be changed (except by changing the value of DDF's site name).
      Parameters:
      id -

    • bind

      public void bind(ddf.catalog.util.Maskable masked)
      Called by blueprint when a service is bound, this method sets the ID of the newly bound Maskable service to the masked ID if the mask ID has been previously set, and adds the new service to the internally maintained list of Maskable services.
      Parameters:
      masked -

    • unbind

      public void unbind(ddf.catalog.util.Maskable masked)
      Called by blueprint when a service is unbound, this method removes the unbound service from the list of Maskable sources maintained internally by this Masker.
      Parameters:
      masked -