Package zowe.client.sdk.teamconfig

Class TeamConfig

java.lang.Object

zowe.client.sdk.teamconfig.TeamConfig

public class TeamConfig
extends Object

TeamConfig class provides API method(s) to retrieve a profile section from Zowe Global Team Configuration with keytar information to help perform ZosConnection processing without hard coding username and password. This class only supports Zowe Global Team Configuration provided by Zowe V2.

Version:

4.0

Author:

Frank Giordano

Constructor Summary

Constructors

Constructor	Description
TeamConfig()	Default TeamConfig constructor without arguments.
TeamConfig(KeyTarService keyTarService, TeamConfigService teamConfigService)	TeamConfig constructor.

Method Summary

Modifier and Type	Method	Description
ProfileDao	getDefaultProfile(String profileType)	Retrieve the default profile for the specified profile type from Zowe Global Team Configuration.
ProfileDao	getDefaultProfileFromPartition(String profileName, String partitionName)	Retrieve the default profile from partition by profile and partition names given from Zowe Global Team Configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

TeamConfig

public TeamConfig()
           throws TeamConfigException

Default TeamConfig constructor without arguments.

Throws:

TeamConfigException - error processing team configuration

TeamConfig

public TeamConfig(KeyTarService keyTarService,
                  TeamConfigService teamConfigService)
           throws TeamConfigException

TeamConfig constructor. This is mainly used for internal code unit testing with mockito.

Parameters:

keyTarService - required KeyTarService dependency

teamConfigService - required TeamConfigService dependency

Throws:

TeamConfigException - error processing team configuration

Method Detail

getDefaultProfile

public ProfileDao getDefaultProfile(String profileType)

Retrieve the default profile for the specified profile type from Zowe Global Team Configuration. Merge properties accordingly with the base profile. Credential store information is also retrieved and piggybacked on a returned ProfileDao object.

Parameters:

profileType - profile type

Returns:

ProfileDao object

getDefaultProfileFromPartition

public ProfileDao getDefaultProfileFromPartition(String profileName,
                                                 String partitionName)

Retrieve the default profile from partition by profile and partition names given from Zowe Global Team Configuration. Merge properties accordingly with the base profile. Credential store information is also retrieved and piggybacked on a returned ProfileDao object.

Parameters:

profileName - profile name

partitionName - partition name

Returns:

ProfileDao object