Package org.apache.maven.settings
Class Mirror
- java.lang.Object
-
- org.apache.maven.settings.TrackableBase
-
- org.apache.maven.settings.IdentifiableBase
-
- org.apache.maven.settings.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
-
-
Field Summary
Fields Modifier and Type Field Description private boolean
blocked
Whether this mirror should be blocked from any download request but fail the download process, explaining why.private java.lang.String
layout
The layout of the mirror repository.private java.lang.String
mirrorOf
The server ID of the repository being mirrored, e.g., "central".private java.lang.String
mirrorOfLayouts
The layouts of repositories being mirrored.private java.lang.String
name
The optional name that describes the mirror.private java.lang.String
url
The URL of the mirror repository.-
Fields inherited from class org.apache.maven.settings.TrackableBase
GLOBAL_LEVEL, USER_LEVEL
-
-
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 org.apache.maven.settings.IdentifiableBase
getId, setId
-
Methods inherited from class org.apache.maven.settings.TrackableBase
getSourceLevel, setSourceLevel
-
-
-
-
Field Detail
-
mirrorOf
private java.lang.String mirrorOf
The server ID of the repository being mirrored, e.g., "central". This MUST NOT match the mirror id.
-
name
private java.lang.String name
The optional name that describes the mirror.
-
url
private java.lang.String url
The URL of the mirror repository.
-
layout
private java.lang.String layout
The layout of the mirror repository. Since Maven 3.
-
mirrorOfLayouts
private java.lang.String mirrorOfLayouts
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.
-
blocked
private boolean blocked
Whether this mirror should be blocked from any download request but fail the download process, explaining why.
-
-
Method Detail
-
clone
public Mirror clone()
Method clone.- Overrides:
clone
in classIdentifiableBase
- Returns:
- Mirror
-
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
-
-
setLayout
public void setLayout(java.lang.String layout)
Set the layout of the mirror repository. Since Maven 3.- Parameters:
layout
-
-
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
-
-
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
-
-
setName
public void setName(java.lang.String name)
Set the optional name that describes the mirror.- Parameters:
name
-
-
setUrl
public void setUrl(java.lang.String url)
Set the URL of the mirror repository.- Parameters:
url
-
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-