Skip to content

Commit

Permalink
doc formatting
Browse files Browse the repository at this point in the history 
Signed-off-by: Nadir K Amra <[email protected]>
  • Loading branch information
@nadiramra
nadiramra committed Mar 29, 2024
1 parent 8879b90 commit 091e85c
Showing 1 changed file with 16 additions and 19 deletions.
35 changes: 16 additions & 19 deletions src/main/java/com/ibm/as400/access/SecureAS400.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@
import com.ibm.as400.security.auth.ProfileTokenCredential;

/**
Represents a secure system sign-on. Secure Sockets Layer (SSL) connections are used to provide encrypted communications. This function requires an SSL capable system at release V4R4 or later.
Represents a secure system sign-on. Secure Sockets Layer (SSL) connections are used to provide encrypted communications.
This function requires an SSL capable system at release V4R4 or later.
**/
public class SecureAS400 extends AS400
{
Expand All @@ -44,7 +45,8 @@ public SecureAS400(String systemName) {
}

/**
Constructs a SecureAS400 object. It uses the specified system name and user ID. When the sign-on prompt is displayed, the user is able to specify the password. Note that the user ID may be overridden.
Constructs a SecureAS400 object. It uses the specified system name and user ID. When the sign-on prompt is displayed,
the user is able to specify the password. Note that the user ID may be overridden.
@param systemName The name of the system.
@param userId The user profile name to use to authenticate to the system.
**/
Expand Down Expand Up @@ -72,29 +74,29 @@ public SecureAS400(String systemName, String userId, String password) {
super(systemName, userId, password);
}

/**
/**
Constructs a SecureAS400 object. It uses the specified system name, user ID, and password. No sign-on prompt is displayed unless the sign-on fails.
@param systemName The name of the system.
@param userId The user profile name to use to authenticate to the system.
@param password The user profile password to use to authenticate to the system.
**/
public SecureAS400(String systemName, String userId, char[] password) {
super(systemName, userId, password);
}

/**
Constructs a SecureAS400 object. It uses the specified system name, user ID, , and additional authentication
factor. No sign-on prompt is displayed unless the sign-on fails.
@param systemName The name of the IBM i system. Use <code>localhost</code> to access data locally.
@param userId The user profile name to use to authenticate to the system. If running on IBM i, *CURRENT may be used to specify the current user ID.
@param password The user profile password to use to authenticate to the system.
@param additionalAuthenticationFactor Additional authentication factor (or null if not providing one).
The caller is responsible for clearing the password array to keep the password from residing in memory.
The caller is responsible for clearing the password array to keep the password from residing in memory.
**/
public SecureAS400(String systemName, String userId, char[] password, char[] additionalAuthenticationFactor) throws IOException, AS400SecurityException {
super(systemName, userId, password, additionalAuthenticationFactor);
}

/**
Constructs a SecureAS400 object. It uses the specified system, user ID, and password. No sign-on prompt is displayed unless the sign-on fails.
@param systemName The name of the system.
Expand All @@ -107,20 +109,20 @@ public SecureAS400(String systemName, String userId, String password, String pro
super(systemName, userId, password, proxyServer);
}

/**
/**
Constructs a SecureAS400 object. It uses the specified system, user ID, and password. No sign-on prompt is displayed unless the sign-on fails.
@param systemName The name of the system.
@param userId The user profile name to use to authenticate to the system.
@param password The user profile password to use to authenticate to the system.
@param proxyServer The name and port in the format <code>serverName[:port]</code>. If no port is specified, a default will be used.
**/
public SecureAS400(String systemName, String userId, char[] password, String proxyServer) {
super(systemName, userId, password, proxyServer);
}

/**
Constructs a SecureAS400 object. It uses the same system name and user ID. This does not create a clone. The new SecureAS400 object has the same behavior, but results in a new set of socket connections.
Constructs a SecureAS400 object. It uses the same system name and user ID. This does not create a clone. The new SecureAS400 object
has the same behavior, but results in a new set of socket connections.
@param system A previously instantiated AS400 or SecureAS400 object.
**/
public SecureAS400(AS400 system) {
Expand All @@ -136,25 +138,22 @@ public SecureAS400(AS400 system) {
@exception IOException If an error occurs while communicating with the system.
@deprecated Use addPasswordCacheEntry(String systemName, String userId, char[] password) instead
**/
public static void addPasswordCacheEntry(String systemName, String userId, String password) throws AS400SecurityException, IOException
{
public static void addPasswordCacheEntry(String systemName, String userId, String password) throws AS400SecurityException, IOException {
addPasswordCacheEntry(systemName, userId, password == null ? (char[])null : password.toCharArray(), true);
}

/**
/**
Validates the user ID and password against the system, and if successful, adds the information to the password cache.
@param systemName The name of the system.
@param userId The user profile name.
@param password The user profile password.
@exception AS400SecurityException If a security or authority error occurs.
@exception IOException If an error occurs while communicating with the system.
**/
public static void addPasswordCacheEntry(String systemName, String userId, char[] password) throws AS400SecurityException, IOException
{
public static void addPasswordCacheEntry(String systemName, String userId, char[] password) throws AS400SecurityException, IOException {
addPasswordCacheEntry(systemName, userId, password, true);
}


/**
Validates the user ID and password against the system, and if successful, adds the information to the password cache.
@param systemName The name of the system.
Expand All @@ -165,8 +164,7 @@ public static void addPasswordCacheEntry(String systemName, String userId, char[
@exception IOException If an error occurs while communicating with the system.
@deprecated Use addPasswordCacheEntry(String systemName, String userId, char[] password, String proxyServer) instead.
**/
public static void addPasswordCacheEntry(String systemName, String userId, String password, String proxyServer) throws AS400SecurityException, IOException
{
public static void addPasswordCacheEntry(String systemName, String userId, String password, String proxyServer) throws AS400SecurityException, IOException {
addPasswordCacheEntry(systemName, userId, password == null ? (char[])null : password.toCharArray(), proxyServer, true);
}

Expand All @@ -179,8 +177,7 @@ public static void addPasswordCacheEntry(String systemName, String userId, Strin
@exception AS400SecurityException If a security or authority error occurs.
@exception IOException If an error occurs while communicating with the system.
**/
public static void addPasswordCacheEntry(String systemName, String userId, char[] password, String proxyServer) throws AS400SecurityException, IOException
{
public static void addPasswordCacheEntry(String systemName, String userId, char[] password, String proxyServer) throws AS400SecurityException, IOException {
addPasswordCacheEntry(systemName, userId, password, proxyServer, true);
}

Expand Down

0 comments on commit 091e85c

Please sign in to comment.