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:

1.0

Author:

Frank Giordano

Constructor Summary

Constructors

Constructor	Description
TeamConfig(KeyTarService keyTarService, TeamConfigService teamConfigService)	TeamConfig constructor

Method Summary

Modifier and Type	Method	Description
ProfileDao	getDefaultProfileByName(String name)	Retrieve default profile by profile name given from Zowe Global Team Configuration.
ProfileDao	getDefaultProfileFromPartitionByName(String profileName, String partitionName)	Retrieve 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(KeyTarService keyTarService,
                  TeamConfigService teamConfigService)
           throws Exception

TeamConfig constructor

Parameters:

keyTarService - required KeyTarService dependency

teamConfigService - required TeamConfigService dependency

Throws:

Exception - error processing

Method Detail

getDefaultProfileByName

public ProfileDao getDefaultProfileByName(String name)
                                   throws Exception

Retrieve default profile by profile name given from Zowe Global Team Configuration. Merge properties accordingly if needed due to absence of important properties from default profile with base profile. Credential store information is also retrieved and piggybacked on returned ProfileDao object.

Parameters:

name - profile name

Returns:

ProfileDao object

Throws:

Exception - error processing

getDefaultProfileFromPartitionByName

public ProfileDao getDefaultProfileFromPartitionByName(String profileName,
                                                       String partitionName)
                                                throws Exception

Retrieve default profile from partition by profile and partition names given from Zowe Global Team Configuration. Merge properties accordingly if needed due to absence of important properties from default profile with base profile. Credential store information is also retrieved and piggybacked on returned ProfileDao object.

Parameters:

profileName - profile name

partitionName - partition name

Returns:

ProfileDao object

Throws:

Exception - error processing