Top Description Fields Constructors Methods
org.apache.sshd.server.auth.keyboard

public Class InteractiveChallenge

extends Object
implements Cloneable
Class Inheritance
All Implemented Interfaces
java.lang.Cloneable
Imports
java.util.ArrayList, .Collection, .List, .Objects, org.apache.sshd.common.util.GenericUtils, org.apache.sshd.common.util.buffer.Buffer

Represents a server "challenge" as per RFC-4256
Author
Apache MINA SSHD Project

Field Summary

Modifier and TypeField and Description
private String
private String
private String
private List<PromptEntry>

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public void
addPrompt(String prompt, boolean echo)

public void
public <B extends Buffer> B
append(B buffer)

public void
public InteractiveChallenge
clone()

Overrides java.lang.Object.clone.

Creates and returns a copy of this object.

public String
public String
public String
public List<PromptEntry>
public void
setInteractionInstruction(String interactionInstruction)

public void
setInteractionName(String interactionName)

public void
setLanguageTag(String languageTag)

public void
setPrompts(Collection<? extends PromptEntry> prompts)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
equalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

interactionInstructionback to summary
private String interactionInstruction
interactionNameback to summary
private String interactionName
languageTagback to summary
private String languageTag
promptsback to summary
private List<PromptEntry> prompts

Constructor Detail

InteractiveChallengeback to summary
public InteractiveChallenge()

Method Detail

addPromptback to summary
public void addPrompt(String prompt, boolean echo)
addPromptback to summary
public void addPrompt(PromptEntry entry)
appendback to summary
public <B extends Buffer> B append(B buffer)
clearPromptsback to summary
public void clearPrompts()
cloneback to summary
public InteractiveChallenge clone()

Overrides java.lang.Object.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x
will be true, and that the expression:
x.clone().getClass() == x.getClass()
will be true, but these are not absolute requirements. While it is typically the case that:
x.clone().equals(x)
will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:InteractiveChallenge

a clone of this instance.

Annotations
@Override
getInteractionInstructionback to summary
public String getInteractionInstruction()
getInteractionNameback to summary
public String getInteractionName()
getLanguageTagback to summary
public String getLanguageTag()
getPromptsback to summary
public List<PromptEntry> getPrompts()
setInteractionInstructionback to summary
public void setInteractionInstruction(String interactionInstruction)
setInteractionNameback to summary
public void setInteractionName(String interactionName)
setLanguageTagback to summary
public void setLanguageTag(String languageTag)
setPromptsback to summary
public void setPrompts(Collection<? extends PromptEntry> prompts)
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override