Package jenkins

Class AgentProtocol

    • Constructor Detail

      • AgentProtocol

        public AgentProtocol()
    • Method Detail

      • isOptIn

        public boolean isOptIn()
        Allow experimental AgentProtocol implementations to declare being opt-in. Note that Jenkins.setAgentProtocols(Set) only records the protocols where the admin has made a conscious decision thus:
        • if a protocol is opt-in, it records the admin enabling it
        • if a protocol is opt-out, it records the admin disabling it
        Implementations should not transition rapidly from opt-in -> opt-out -> opt-in. Implementations should never flip-flop: opt-in -> opt-out -> opt-in -> opt-out as that will basically clear any preference that an admin has set. This latter restriction should be ok as we only ever will be adding new protocols and retiring old ones.
        Returns:
        true if the protocol requires explicit opt-in.
        Since:
        2.16
        See Also:
        Jenkins.setAgentProtocols(Set)
      • isDeprecated

        public boolean isDeprecated()
        Checks if the protocol is deprecated.
        Since:
        2.75
      • getName

        public abstract String getName()
        Protocol name. This is a short string that consists of printable ASCII chars. Sent by the client to select the protocol.
        Returns:
        null to be disabled. This is useful for avoiding getting used until the protocol is properly configured.
      • getDisplayName

        public String getDisplayName()
        Returns the human readable protocol display name.
        Returns:
        the human readable protocol display name.
        Since:
        2.16