Package com.compuware.api.topaz.hostcredentials.zos

Class ZOSCredentialsFactory

java.lang.Object

com.compuware.api.topaz.hostcredentials.zos.ZOSCredentialsFactory

public final class ZOSCredentialsFactory
extends Object

This factory is used to create z/OS credentials for connecting to z/OS hosts.

This class is not intended to be instantiated or extended by clients.

Since:

1.0.0

Version:

2.0.0

See Also:

IZOSHostConnection.connect(IZOSCredentials)

Restriction:

This class is not intended to be extended by clients.

Method Summary

Modifier and Type	Method	Description
static IZOSCredentials	createZOSCredentials(String digitalCertificate)	Creates z/OS credentials using the specified digital certificate.
static IZOSCredentials	createZOSCredentials(String digitalCertificate, CodePage codePage)	Creates z/OS credentials using the specified digital certificate and code page.
static IZOSCredentials	createZOSCredentials(String userID, String password)	Creates z/OS credentials using the specified user ID and password.
static IZOSCredentials	createZOSCredentials(String userID, String password, CodePage codePage)	Creates z/OS credentials using the specified user ID, password, and code page.
static IZOSCredentials	createZOSCredentials(String userID, String password, String groupID)	Creates z/OS credentials using the specified user ID, password, and group ID.
static IZOSCredentials	createZOSCredentials(String userID, String password, String groupID, CodePage codePage)	Creates z/OS credentials using the specified user ID, password, group ID, and code page.

Methods inherited from class java.lang.Object

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

Method Detail

createZOSCredentials

public static IZOSCredentials createZOSCredentials(String digitalCertificate)

Creates z/OS credentials using the specified digital certificate. Code page 1047 is assumed.

Parameters:

digitalCertificate - a Base64-encoded string that represents a digital certificate

Returns:

z/OS credentials

Throws:

IllegalArgumentException - if digitalCertificate is null or empty

Since:

1.0.0

createZOSCredentials

public static IZOSCredentials createZOSCredentials(String digitalCertificate,
                                                   CodePage codePage)

Creates z/OS credentials using the specified digital certificate and code page.

Parameters:

digitalCertificate - a Base64-encoded string that represents a digital certificate

codePage - the code page (if null, code page 1047 is assumed)

Returns:

z/OS credentials

Throws:

IllegalArgumentException - if digitalCertificate is null or empty

Since:

1.0.0

createZOSCredentials

public static IZOSCredentials createZOSCredentials(String userID,
                                                   String password)

Creates z/OS credentials using the specified user ID and password. Code page 1047 is assumed.

Parameters:

userID - the user ID

password - the password

Returns:

z/OS credentials

Throws:

IllegalArgumentException - if userID or password is null or empty

Since:

1.0.0

createZOSCredentials

public static IZOSCredentials createZOSCredentials(String userID,
                                                   String password,
                                                   String groupID)

Creates z/OS credentials using the specified user ID, password, and group ID. Code page 1047 is assumed.

Parameters:

userID - the user ID

password - the password

groupID - the group ID or null to not specify a group ID

Returns:

z/OS credentials

Throws:

IllegalArgumentException - if userID or password is null or empty

Since:

1.0.0

createZOSCredentials

public static IZOSCredentials createZOSCredentials(String userID,
                                                   String password,
                                                   CodePage codePage)

Creates z/OS credentials using the specified user ID, password, and code page.

Parameters:

userID - the user ID

password - the password

codePage - the code page (if null, code page 1047 is assumed)

Returns:

z/OS credentials

Throws:

IllegalArgumentException - if userID or password is null or empty

Since:

1.0.0

createZOSCredentials

public static IZOSCredentials createZOSCredentials(String userID,
                                                   String password,
                                                   String groupID,
                                                   CodePage codePage)

Creates z/OS credentials using the specified user ID, password, group ID, and code page.

Parameters:

userID - the user ID

password - the password

groupID - the group ID or null to not specify a group ID

codePage - the code page (if null, code page 1047 is assumed)

Returns:

z/OS credentials

Throws:

IllegalArgumentException - if userID or password is null or empty

Since:

1.0.0