Package zowe.client.sdk.teamconfig.keytar

Interface IKeyTar

All Known Implementing Classes:

KeyTarImpl

public interface IKeyTar

Interface that describes the contract for KeyTar processing

Version:

2.0

Author:

Frank Giordano

Method Summary

Modifier and Type	Method	Description
List<KeyTarConfig>	getKeyConfigs()	Describes the method that will retrieve KeyTar key information
String	getKeyTarValue()	Describes the method that will return KeyTar value from KeyTar processing done
void	processKey()	Describes the method that will extract KeyTar key information
void	setAccountName(String accountName)	Set required service name used for OS credential store querying
void	setServiceName(String serviceName)	Set required account name used for OS credential store querying

Method Detail

getKeyConfigs

List<KeyTarConfig> getKeyConfigs()
                          throws TeamConfigException

Describes the method that will retrieve KeyTar key information

Returns:

list of KeyTarConfig objects

Throws:

TeamConfigException - error processing team configuration

getKeyTarValue

String getKeyTarValue()

Describes the method that will return KeyTar value from KeyTar processing done

Returns:

keyValue string containing KeyTar Json representation

processKey

void processKey()
         throws TeamConfigException

Describes the method that will extract KeyTar key information

Throws:

TeamConfigException - error processing team configuration

setAccountName

void setAccountName(String accountName)

Set required service name used for OS credential store querying

Parameters:

accountName - string value used for OS credential store querying

setServiceName

void setServiceName(String serviceName)

Set required account name used for OS credential store querying

Parameters:

serviceName - string value used for OS credential store querying