com.ibm.cloud.objectstorage.auth.profile.internal

Class AbstractProfilesConfigFileScanner

java.lang.Object

com.ibm.cloud.objectstorage.auth.profile.internal.AbstractProfilesConfigFileScanner

public abstract class AbstractProfilesConfigFileScanner
extends Object

An abstract template class for the generic operation that involves scanning through a profile configuration file. Subclass should implement the abstract methods to define the actions when different components of the profiles file are detected.

Constructor Summary

Constructors

Constructor and Description
AbstractProfilesConfigFileScanner()

Method Summary

Modifier and Type	Method and Description
protected boolean	isSupportedProperty(String propertyName) Hook to allow subclasses to determine which properties are supported and which aren't.
protected abstract void	onEmptyOrCommentLine(String profileName, String line) Action to be performed when an empty or comment line is detected
protected abstract void	onEndOfFile() Action to be performed when the scanner reaches the end of the credentials file.
protected abstract void	onProfileEndingLine(String prevProfileName) Action to be performed when the scanner reaches the end of a profile section.
protected abstract void	onProfileProperty(String profileName, String propertyName, String propertyValue, boolean isSupportedProperty, String line) Action to be performed when a property declaration is detected inside a profile section.
protected abstract void	onProfileStartingLine(String newProfileName, String line) Action to be performed when the starting line of a new profile is detected
protected void	run(Scanner scanner) Scan through the given input, and perform the defined actions.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractProfilesConfigFileScanner

public AbstractProfilesConfigFileScanner()

Method Detail

onEmptyOrCommentLine

protected abstract void onEmptyOrCommentLine(String profileName,
                                             String line)

Action to be performed when an empty or comment line is detected

onProfileStartingLine

protected abstract void onProfileStartingLine(String newProfileName,
                                              String line)

Action to be performed when the starting line of a new profile is detected

onProfileEndingLine

protected abstract void onProfileEndingLine(String prevProfileName)

Action to be performed when the scanner reaches the end of a profile section. This method is invoked either at the start of a new profile section, or at the end of the file.

onEndOfFile

protected abstract void onEndOfFile()

Action to be performed when the scanner reaches the end of the credentials file.

onProfileProperty

protected abstract void onProfileProperty(String profileName,
                                          String propertyName,
                                          String propertyValue,
                                          boolean isSupportedProperty,
                                          String line)

Action to be performed when a property declaration is detected inside a profile section.

Parameters:

profileName - The name of the profile where this property is declared.

propertyName - The name of the property.

propertyValue - The value of the property.

isSupportedProperty - Whether this is a supported property according to the specification of credential profiles file.

line - The original line of text where the property is declared.

isSupportedProperty

protected boolean isSupportedProperty(String propertyName)

Hook to allow subclasses to determine which properties are supported and which aren't.

Returns:

True if property is supported by scanner implementation, false otherwise.

run

protected void run(Scanner scanner)

Scan through the given input, and perform the defined actions.

Parameters:

scanner - The scanner for the credentials file input.