IKeyTar (org.zowe.client.java.sdk:zowe-client-java-sdk 1.1.1 API)

All Known Implementing Classes:

KeyTarImpl
```
public interface IKeyTar
```
Interface that describes the contract for KeyTar processing

Version:

1.0

Author:

Frank Giordano

Method Summary

All Methods Instance Methods Abstract Methods
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 Exception
```
    Describes the method that will retrieve KeyTar key information
    
    Returns:
    
    list of KeyTarConfig objects
    
    Throws:
    
    Exception - error processing
  - getKeyTarValue
```
String getKeyTarValue()
               throws Exception
```
    Describes the method that will return KeyTar value from KeyTar processing done
    
    Returns:
    
    keyValue string containing KeyTar Json representation
    
    Throws:
    
    Exception - error processing
  - processKey
```
void processKey()
         throws com.starxg.keytar.KeytarException
```
    Describes the method that will extract KeyTar key information
    
    Throws:
    
    com.starxg.keytar.KeytarException - error processing
  - 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