org.springframework.credhub.support.ssh

Class SshParameters

java.lang.Object

org.springframework.credhub.support.KeyParameters

org.springframework.credhub.support.ssh.SshParameters

public class SshParameters
extends KeyParameters

Parameters for generating a new SSH credential. All parameters are optional; if not specified, CredHub-provided defaults will be used.

Author:

Scott Frederick

Field Summary

Fields inherited from class org.springframework.credhub.support.KeyParameters

keyLength

Constructor Summary

Constructors

Constructor and Description
SshParameters(KeyLength keyLength) Create a SshParameters using the specified values.
SshParameters(KeyLength keyLength, String sshComment) Create a SshParameters using the specified values.
SshParameters(String sshComment) Create a SshParameters using the specified values.

Method Summary

Modifier and Type	Method and Description
String	getSshComment() Get the value of the ssh comment parameter.

Methods inherited from class org.springframework.credhub.support.KeyParameters

getKeyLength

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SshParameters

public SshParameters(String sshComment)

Create a SshParameters using the specified values.

Parameters:

sshComment - comment for the generated SSH key; must not be null

SshParameters

public SshParameters(KeyLength keyLength)

Create a SshParameters using the specified values.

Parameters:

keyLength - length of generated SSH key; must not be null

SshParameters

public SshParameters(KeyLength keyLength,
                     String sshComment)

Create a SshParameters using the specified values.

Parameters:

keyLength - length of generated SSH key; must not be null

sshComment - comment for the generated SSH key; must not be null

Method Detail

getSshComment

public String getSshComment()

Get the value of the ssh comment parameter.

Returns:

the value of the parameter; will be null if not explicitly set