Class Server

java.lang.Object
org.apache.maven.api.settings.TrackableBase
org.apache.maven.api.settings.IdentifiableBase
org.apache.maven.api.settings.Server
All Implemented Interfaces:
Serializable, InputLocationTracker
@Experimental @Generated @ThreadSafe @Immutable public class Server extends IdentifiableBase implements Serializable, InputLocationTracker
The <server> element contains information required to a server settings.
See Also:

  • Constructor Details

  • Method Details

    • getUsername

      public String getUsername()
      The username used to authenticate.
      Returns:
      a String

    • getPassword

      public String getPassword()
      The password used in conjunction with the username to authenticate.
      Returns:
      a String

    • getPrivateKey

      public String getPrivateKey()
      The private key location used to authenticate.
      Returns:
      a String

    • getPassphrase

      public String getPassphrase()
      The passphrase used in conjunction with the privateKey to authenticate.
      Returns:
      a String

    • getFilePermissions

      public String getFilePermissions()
      The permissions for files when they are created.
      Returns:
      a String

    • getDirectoryPermissions

      public String getDirectoryPermissions()
      The permissions for directories when they are created.
      Returns:
      a String

    • getConfiguration

      public org.apache.maven.api.xml.XmlNode getConfiguration()
      Extra configuration for the transport layer.
      Returns:
      a XmlNode

    • with

      @Nonnull public Server.Builder with()
      Creates a new builder with this object as the basis.
      Overrides:
      with in class IdentifiableBase
      Returns:
      a Builder

    • withId

      @Nonnull public Server withId(String id)
      Creates a new Server instance using the specified id.
      Overrides:
      withId in class IdentifiableBase
      Parameters:
      id - the new String to use
      Returns:
      a Server with the specified id

    • withUsername

      @Nonnull public Server withUsername(String username)
      Creates a new Server instance using the specified username.
      Parameters:
      username - the new String to use
      Returns:
      a Server with the specified username

    • withPassword

      @Nonnull public Server withPassword(String password)
      Creates a new Server instance using the specified password.
      Parameters:
      password - the new String to use
      Returns:
      a Server with the specified password

    • withPrivateKey

      @Nonnull public Server withPrivateKey(String privateKey)
      Creates a new Server instance using the specified privateKey.
      Parameters:
      privateKey - the new String to use
      Returns:
      a Server with the specified privateKey

    • withPassphrase

      @Nonnull public Server withPassphrase(String passphrase)
      Creates a new Server instance using the specified passphrase.
      Parameters:
      passphrase - the new String to use
      Returns:
      a Server with the specified passphrase

    • withFilePermissions

      @Nonnull public Server withFilePermissions(String filePermissions)
      Creates a new Server instance using the specified filePermissions.
      Parameters:
      filePermissions - the new String to use
      Returns:
      a Server with the specified filePermissions

    • withDirectoryPermissions

      @Nonnull public Server withDirectoryPermissions(String directoryPermissions)
      Creates a new Server instance using the specified directoryPermissions.
      Parameters:
      directoryPermissions - the new String to use
      Returns:
      a Server with the specified directoryPermissions

    • withConfiguration

      @Nonnull public Server withConfiguration(org.apache.maven.api.xml.XmlNode configuration)
      Creates a new Server instance using the specified configuration.
      Parameters:
      configuration - the new XmlNode to use
      Returns:
      a Server with the specified configuration

    • newInstance

      @Nonnull public static Server newInstance()
      Creates a new Server instance. Equivalent to newInstance(true).
      Returns:
      a new Server
      See Also:

    • newInstance

      @Nonnull public static Server newInstance(boolean withDefaults)
      Creates a new Server instance using default values or not. Equivalent to newBuilder(withDefaults).build().
      Parameters:
      withDefaults - the boolean indicating whether default values should be used
      Returns:
      a new Server

    • newBuilder

      @Nonnull public static Server.Builder newBuilder()
      Creates a new Server builder instance. Equivalent to newBuilder(true).
      Returns:
      a new Builder
      See Also:

    • newBuilder

      @Nonnull public static Server.Builder newBuilder(boolean withDefaults)
      Creates a new Server builder instance using default values or not.
      Parameters:
      withDefaults - the boolean indicating whether default values should be used
      Returns:
      a new Builder

    • newBuilder

      @Nonnull public static Server.Builder newBuilder(Server from)
      Creates a new Server builder instance using the specified object as a basis. Equivalent to newBuilder(from, false).
      Parameters:
      from - the Server instance to use as a basis
      Returns:
      a new Builder

    • newBuilder

      @Nonnull public static Server.Builder newBuilder(Server from, boolean forceCopy)
      Creates a new Server builder instance using the specified object as a basis.
      Parameters:
      from - the Server instance to use as a basis
      forceCopy - the boolean indicating if a copy should be forced
      Returns:
      a new Builder