Package com.day.cq.wcm.webservicesupport

Interface Configuration

public interface Configuration
Represents a web service configuration.
Since:
5.5

  • Method Details

    • getTitle

      String getTitle()
      Return the jcr:title property of the service.
      Returns:
      String representation of title

    • getDescription

      String getDescription()
      Return jcr:description property of the service.
      Returns:
      String representation of description

    • getName

      String getName()
      Returns the name of the configuration. This is the last segment of the configuration path.
      Returns:
      String representation of name

    • getPath

      String getPath()
      Returns the path of the configuration.
      Returns:
      String representation of path

    • getLastModified

      Long getLastModified()
      Return the Date of last modification of the configuration.
      Returns:
      UTC milliseconds of the last modification date

    • getIconPath

      String getIconPath()
      Returns the path to an icon for this service or null if this service does not provide an icon.
      Returns:
      Path to an icon or null

    • getThumbnailPath

      String getThumbnailPath()
      Returns the path to a thumbnail for this service or null if this service does not provide a thumbnail.
      Returns:
      Path to an icon or null

    • getTemplate

      Template getTemplate()
      Returns the pages Template or null if no template has been found or the current user does not have read access to the template resource specified by the path in the page's template property. This is the case on publish instances using default ACL configuration (anonymous cannot read templates).
      Returns:
      Page Template or null

    • getParent

      Resource getParent()
      Returns the relative parent configuration Resource.
      Returns:
      Resource or null

    • getResource

      Resource getResource()
      Returns the configuration Resource.
      Returns:
      Resource or null

    • getContentResource

      Resource getContentResource()
      Returns the Resources content or null.
      Returns:
      Resource or null

    • getProperties

      InheritanceValueMap getProperties()
      Returns all properties of this node accessible through the current Session.
      Returns:
      InheritanceValueMap with all inherited properties

    • get

      <T> T get(String name, T defaultValue)
      Returns a property with provided name of type T or the default value if property was not found.
      Type Parameters:
      T - Type of the property
      Parameters:
      name - Property name
      defaultValue - Default value
      Returns:
      Property value

    • getInherited

      <T> T getInherited(String name, T defaultValue)
      Returns a property with provided name of type T or the default value if property was not found. Takes properties of parent resources / pages into account, if the property is not found locally.
      Type Parameters:
      T - Type of the property
      Parameters:
      name - Property name
      defaultValue - Default value
      Returns:
      Property value

    • listChildren

      Iterator<Configuration> listChildren()
      Returns an Iterator of Configuration objects loaded from the children of the given Resource
      Returns:
      Configuration child Iterator