Package org.opencms.db

Class CmsExportPoint

  • All Implemented Interfaces:
    java.io.Serializable
    public class CmsExportPoint
extends java.lang.Object
implements java.io.Serializable
    Contains the data of a single export point.

    Since:
    6.0.0
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      CmsExportPoint()
      Creates a new, empty export point.
      CmsExportPoint​(java.lang.String uri, java.lang.String destination)
      Creates a new export point.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Object clone()  
      boolean equals​(java.lang.Object obj)  
      java.lang.String getConfiguredDestination()
      Returns the configured destination path.
      java.lang.String getDestinationPath()
      Returns the destination path in the "real" file system.
      java.lang.String getUri()
      Returns the uri of the OpenCms VFS folder to write as export point.
      int hashCode()  
      void setConfiguredDestination​(java.lang.String value)
      Sets the configured destination path.
      void setDestinationPath​(java.lang.String value)
      Dummy method to expose the destination path as bean property.
      void setUri​(java.lang.String value)
      Sets the uri of the OpenCms VFS folder to write as export point.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • CmsExportPoint

        public CmsExportPoint()
        Creates a new, empty export point.

      • CmsExportPoint

        public CmsExportPoint​(java.lang.String uri,
                      java.lang.String destination)
        Creates a new export point.

        Parameters:
        uri - the folder in the OpenCms VFS to write as export point
        destination - the destination folder in the "real" file system, relative to the web application root

    • Method Detail

      • clone

        public java.lang.Object clone()
        Overrides:
        clone in class java.lang.Object
        See Also:
        Object.clone()

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
        See Also:
        Object.equals(java.lang.Object)

      • getConfiguredDestination

        public java.lang.String getConfiguredDestination()
        Returns the configured destination path.

        The configured destination path is always relative to the web application path.

        Returns:
        the configured destination path
        See Also:
        getDestinationPath()

      • getDestinationPath

        public java.lang.String getDestinationPath()
        Returns the destination path in the "real" file system.

        Returns:
        the destination

      • getUri

        public java.lang.String getUri()
        Returns the uri of the OpenCms VFS folder to write as export point.

        Returns:
        the uri

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
        See Also:
        Object.hashCode()

      • setConfiguredDestination

        public void setConfiguredDestination​(java.lang.String value)
        Sets the configured destination path.

        The configured destination path is always relative to the web application path.

        This set method will automatically set the destination path as well.

        Parameters:
        value - the configured destination path

      • setDestinationPath

        public void setDestinationPath​(java.lang.String value)
        Dummy method to expose the destination path as bean property.

        This is required by the BeanUtils package in order to enable using this Object with the digester.

        The method does not actually change the value of the destination path. Use the setConfiguredDestination(String) method instead.

        Parameters:
        value - the destination path (will be ignored)

      • setUri

        public void setUri​(java.lang.String value)
        Sets the uri of the OpenCms VFS folder to write as export point.

        Parameters:
        value - the uri to set

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
        See Also:
        Object.toString()