Package org.bedework.synch.shared

Class PropertiesInfo

java.lang.Object
org.bedework.synch.shared.PropertiesInfo
public class PropertiesInfo extends Object
Help handling properties. This class will hold property info for the parent object. This is built by calls to add. It will also build a new PropertiesInfo object based on a set of properties and a set of current values. This can then be used to transmit the current values to a remote client.
Author:
douglm

  • Constructor Details

    • PropertiesInfo

      public PropertiesInfo()

  • Method Details

    • requiredUri

      public void requiredUri(String description)
      URI
      Parameters:
      description - null for default description

    • optionalUri

      public void optionalUri(String description)
      URI
      Parameters:
      description - null for default description

    • requiredPrincipal

      public void requiredPrincipal(String description)
      Principal
      Parameters:
      description - null for default description

    • optionalPrincipal

      public void optionalPrincipal(String description)
      Principal
      Parameters:
      description - null for default description

    • requiredPassword

      public void requiredPassword(String description)
      Password
      Parameters:
      description - null for default description

    • optionalPassword

      public void optionalPassword(String description)
      Password
      Parameters:
      description - null for default description

    • add

      public void add(String name, boolean secure, String type, String description, boolean required)
      No-value form
      Parameters:
      name - - name for the property
      secure - - true if this property value should be hidden, e.g password
      type - - type of the property - see above
      description - - of the property
      required - - true if this property is required

    • add

      public void add(String name, boolean secure, String type, String description, boolean required, String value)
      value form
      Parameters:
      name - - name for the property
      secure - - true if this property value should be hidden, e.g password
      type - - type of the property - see above
      description - - of the property
      required - - true if this property is required
      value - - the default or current value as a Java string representation

    • optionCalProcessing

      public void optionCalProcessing(String name, String description)
      Add an optional property of type CalProcessing with no default value.
      Parameters:
      name - - name for the property
      description - - of the property

    • optionCalProcessing

      public void optionCalProcessing(String name, String description, String value)
      Add an optional property of type CalProcessing with the given default value.
      Parameters:
      name - - name for the property
      description - - of the property
      value - - the default or current value as a Java string representation

    • validSubscribeInfoProperties

      public boolean validSubscribeInfoProperties(BaseSubscriptionInfo info) throws SynchException
      Ensure info properties are valid for a new subscription
      Parameters:
      info -
      Returns:
      true if all ok
      Throws:
      SynchException

    • validRequestProperties

      public boolean validRequestProperties(BaseSubscriptionInfo info, org.bedework.synch.wsmessages.ArrayOfSynchProperties propsArray) throws SynchException
      Ensure info properties are valid for an existing subscription
      Parameters:
      info - - current properties
      propsArray - - properties in a request to be validated
      Returns:
      true if all ok
      Throws:
      SynchException

    • addAllToList

      public void addAllToList(List<org.bedework.synch.wsmessages.SynchPropertyInfoType> l)
      Add all the properties in this list to the parameter
      Parameters:
      l -

    • toString

      public String toString()
      Overrides:
      toString in class Object