Class Mirror

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable

    public class Mirror
    extends IdentifiableBase
    implements java.io.Serializable, java.lang.Cloneable
    A download mirror for a given repository.
    Version:
    $Revision$ $Date$
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor Description
      Mirror()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Mirror clone()
      Method clone.
      java.lang.String getLayout()
      Get the layout of the mirror repository.
      java.lang.String getMirrorOf()
      Get the server ID of the repository being mirrored, e.g., "central".
      java.lang.String getMirrorOfLayouts()
      Get the layouts of repositories being mirrored.
      java.lang.String getName()
      Get the optional name that describes the mirror.
      java.lang.String getUrl()
      Get the URL of the mirror repository.
      boolean isBlocked()
      Get whether this mirror should be blocked from any download request but fail the download process, explaining why.
      void setBlocked​(boolean blocked)
      Set whether this mirror should be blocked from any download request but fail the download process, explaining why.
      void setLayout​(java.lang.String layout)
      Set the layout of the mirror repository.
      void setMirrorOf​(java.lang.String mirrorOf)
      Set the server ID of the repository being mirrored, e.g., "central".
      void setMirrorOfLayouts​(java.lang.String mirrorOfLayouts)
      Set the layouts of repositories being mirrored.
      void setName​(java.lang.String name)
      Set the optional name that describes the mirror.
      void setUrl​(java.lang.String url)
      Set the URL of the mirror repository.
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

        equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • Mirror

        public Mirror()
    • Method Detail

      • getLayout

        public java.lang.String getLayout()
        Get the layout of the mirror repository. Since Maven 3.
        Returns:
        String
      • getMirrorOf

        public java.lang.String getMirrorOf()
        Get the server ID of the repository being mirrored, e.g., "central". This MUST NOT match the mirror id.
        Returns:
        String
      • getMirrorOfLayouts

        public java.lang.String getMirrorOfLayouts()
        Get the layouts of repositories being mirrored. This value can be used to restrict the usage of the mirror to repositories with a matching layout (apart from a matching id). Since Maven 3.
        Returns:
        String
      • getName

        public java.lang.String getName()
        Get the optional name that describes the mirror.
        Returns:
        String
      • getUrl

        public java.lang.String getUrl()
        Get the URL of the mirror repository.
        Returns:
        String
      • isBlocked

        public boolean isBlocked()
        Get whether this mirror should be blocked from any download request but fail the download process, explaining why.
        Returns:
        boolean
      • setBlocked

        public void setBlocked​(boolean blocked)
        Set whether this mirror should be blocked from any download request but fail the download process, explaining why.
        Parameters:
        blocked - a blocked object.
      • setLayout

        public void setLayout​(java.lang.String layout)
        Set the layout of the mirror repository. Since Maven 3.
        Parameters:
        layout - a layout object.
      • setMirrorOf

        public void setMirrorOf​(java.lang.String mirrorOf)
        Set the server ID of the repository being mirrored, e.g., "central". This MUST NOT match the mirror id.
        Parameters:
        mirrorOf - a mirrorOf object.
      • setMirrorOfLayouts

        public void setMirrorOfLayouts​(java.lang.String mirrorOfLayouts)
        Set the layouts of repositories being mirrored. This value can be used to restrict the usage of the mirror to repositories with a matching layout (apart from a matching id). Since Maven 3.
        Parameters:
        mirrorOfLayouts - a mirrorOfLayouts object.
      • setName

        public void setName​(java.lang.String name)
        Set the optional name that describes the mirror.
        Parameters:
        name - a name object.
      • setUrl

        public void setUrl​(java.lang.String url)
        Set the URL of the mirror repository.
        Parameters:
        url - a url object.
      • toString

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