Package com.perforce.p4java.option.server

Class Login2Options

  • public class Login2Options
extends Options

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected boolean allHosts
      If true, the ticket is valid on all hosts; corresponds to -a flag.
      protected java.lang.String host
      If not null, causes the server to issue a ticket that is valid on the specified host (IP address).
      protected java.lang.String method
      If not null, the chosen method provided to the -m flag
      static java.lang.String OPTIONS_SPECS
      Options: p4 login2 [ -p -R ] [ -h host ] [ -S state ] [ -m method ] [ username ] p4 login2 -s [ -a | -h host ] [ username ]
      protected boolean persist
      If true, the second factor authorization persists even after the ticket has expired
      protected boolean restart
      If true, the second factor authentication can be restarted, allowing users to re-request a OTP, etc
      protected java.lang.String state
      For non-interactive clients, the -S flag can be used to execute each step of the second factor authentication individually.
      protected boolean status
      If true, displays the second factor authorization status for the user

    • Constructor Summary

      Constructors 
      Constructor Description
      Login2Options()
      Default constructor.
      Login2Options​(java.lang.String... options)
      Strings-based constructor; see 'p4 help [command]' for possible options.

    • Field Detail

      • OPTIONS_SPECS

        public static final java.lang.String OPTIONS_SPECS
        Options: p4 login2 [ -p -R ] [ -h host ] [ -S state ] [ -m method ] [ username ] p4 login2 -s [ -a | -h host ] [ username ]
        See Also:
        Constant Field Values

      • persist

        protected boolean persist
        If true, the second factor authorization persists even after the ticket has expired

      • restart

        protected boolean restart
        If true, the second factor authentication can be restarted, allowing users to re-request a OTP, etc

      • host

        protected java.lang.String host
        If not null, causes the server to issue a ticket that is valid on the specified host (IP address). This flag can only be used when the login request is for another user. Corresponds to -h flag.

      • state

        protected java.lang.String state
        For non-interactive clients, the -S flag can be used to execute each step of the second factor authentication individually.

      • method

        protected java.lang.String method
        If not null, the chosen method provided to the -m flag

      • status

        protected boolean status
        If true, displays the second factor authorization status for the user

      • allHosts

        protected boolean allHosts
        If true, the ticket is valid on all hosts; corresponds to -a flag.

    • Constructor Detail

      • Login2Options

        public Login2Options()
        Default constructor.

      • Login2Options

        public Login2Options​(java.lang.String... options)
        Strings-based constructor; see 'p4 help [command]' for possible options.

        WARNING: you should not pass more than one option or argument in each string parameter. Each option or argument should be passed-in as its own separate string parameter, without any spaces between the option and the option value (if any).

        NOTE: setting options this way always bypasses the internal options values, and getter methods against the individual values corresponding to the strings passed in to this constructor will not normally reflect the string's setting. Do not use this constructor unless you know what you're doing and / or you do not also use the field getters and setters.

        Parameters:
        options - options
        See Also:
        Options(java.lang.String...)

    • Method Detail

      • processOptions

        public java.util.List<java.lang.String> processOptions​(IServer server)
                                                throws OptionsException
        Description copied from class: Options
        Turn this (specific) options object into a list of strings to be sent to the Perforce server as options for a specific command. As a side effect, set the option list associated with this Option to the result.

        The method is used by the server object to generate the string-based arguments expected by the Perforce server corresponding to the state of this method-specific options object. Will return an empty list if there are no "interesting" options set or available. May simply return the superclass options string list if is non-null, but that behaviour is neither guaranteed nor required.

        Note that this method is not intended to be called directly by users but by the underlying P4Java plumbing; odd results may occur if this method is called in other contexts.

        Specified by:
        processOptions in class Options
        Parameters:
        server - possibly-null IServer representing the Perforce server the options are to be used against. If this parameter is null, it is acceptable to throw an OptionsException, but it is also possible to ignore it and do the best you can with what you've got...
        Returns:
        non-null (but possibly empty) string list representing the normalized Perforce server arguments corresponding to the state of this specific options object.
        Throws:
        OptionsException - if an error occurs in options processing that is not some species of ConnectionException, RequestException, AccessException, etc.
        See Also:
        Options.processOptions(com.perforce.p4java.server.IServer)

      • isPersist

        public boolean isPersist()

      • setPersist

        public Login2Options setPersist​(boolean persist)

      • isRestart

        public boolean isRestart()

      • setRestart

        public Login2Options setRestart​(boolean restart)

      • getHost

        public java.lang.String getHost()

      • setHost

        public Login2Options setHost​(java.lang.String host)

      • getState

        public java.lang.String getState()

      • setState

        public Login2Options setState​(java.lang.String state)

      • getMethod

        public java.lang.String getMethod()

      • setMethod

        public Login2Options setMethod​(java.lang.String method)

      • isStatus

        public boolean isStatus()

      • isAllHosts

        public boolean isAllHosts()

      • setAllHosts

        public Login2Options setAllHosts​(boolean allHosts)