com.oneops.proxy.model

Class AppSecret

java.lang.Object

com.oneops.proxy.model.AppSecret

public class AppSecret
extends Object

A domain model to represents keywhiz application group secret in GroupController. It basically contain information about application group and secret name extracted from user request.

Author:

Suresh

Field Summary

Fields

Modifier and Type	Field and Description
static String	APP_SECRET_PARAM Secret path param name used in rest controller.
static String	DESC_METADATA
static String	FILENAME_METADATA The attributes used in secret metadata
static String	UNIQ_NAME_SEP '@' is used as unique name separator as it's url safe.
static String	USERID_METADATA

Constructor Summary

Constructors

Constructor and Description
AppSecret(String uniqSecretName) Create AppSecret from the globally unique secret name.
AppSecret(String secretName, AppGroup group) Constructor for app secret.
AppSecret(String secretName, String domain, String appName) Constructor for app secret.

Method Summary

Modifier and Type	Method and Description
String	getAppName() Returns the app name.
AppGroup	getGroup() Returns the application group (env) details for the secret (secretName)
String	getGroupName() Returns the keywhiz group name.
String	getSecretName() Returns the secret name used by the user.
String	getUniqSecretName() Keywhiz is designed to have globally unique names.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

APP_SECRET_PARAM

public static final String APP_SECRET_PARAM

Secret path param name used in rest controller.

See Also:

Constant Field Values

FILENAME_METADATA

public static final String FILENAME_METADATA

The attributes used in secret metadata

See Also:

Constant Field Values

USERID_METADATA

public static final String USERID_METADATA

See Also:

Constant Field Values

DESC_METADATA

public static final String DESC_METADATA

See Also:

Constant Field Values

UNIQ_NAME_SEP

public static final String UNIQ_NAME_SEP

'@' is used as unique name separator as it's url safe.

See Also:

Constant Field Values

Constructor Detail

AppSecret

public AppSecret(@Nonnull
                 String secretName,
                 @Nonnull
                 String domain,
                 @Nonnull
                 String appName)

Constructor for app secret.

Parameters:

secretName - secret name.

domain - Application domain

appName - Application name.

AppSecret

public AppSecret(@Nonnull
                 String secretName,
                 @Nonnull
                 AppGroup group)

Constructor for app secret.

Parameters:

secretName - secret name.

group - AppGroup

AppSecret

public AppSecret(@Nonnull
                 String uniqSecretName)

Create AppSecret from the globally unique secret name.

Parameters:

uniqSecretName - globally unique secret name. It has the format {domain}_{AppGroupName}@{secretName}

Method Detail

getSecretName

public String getSecretName()

Returns the secret name used by the user. The secret name is usually used as the secret file name in applications.

Returns:

secret name.

getGroup

public AppGroup getGroup()

Returns the application group (env) details for the secret (secretName)

Returns:

AppGroup

getUniqSecretName

public String getUniqSecretName()

Keywhiz is designed to have globally unique names. This method returns a globally unique secret name based on your application group.

The unique secret name format is := {domain}_{AppGroupName}@{secretName}

Eg: If user uploads a secret with name db-password.txt for an env prod, assembly my-app and org oneops, the app id is oneops_my-app_prod and the secret name stored in keywhiz server will be prod_oneops_my-app_prod@db-password.txt. The initial prod_ is the default domain. The domain is mainly used to support multiple OneOps instances.

Returns:

String globally unique secret name.

getGroupName

public String getGroupName()

Returns the keywhiz group name.

Returns:

Group name.

getAppName

public String getAppName()

Returns the app name.

Returns:

App name..

toString

public String toString()

Overrides:

toString in class Object