All Classes and Interfaces
Class
Description
An abstract class where common credential-related details are stored.
An abstract manager which attempts to provide all the boilerplate code
necessary to write a Manager in Galasa.
A base validator class that contains commonly-used validation methods
A representation of a content type as given in a HTTP "Accept" header.
Represents annotated fields that the AbstractManager finds on behalf of
Managers
Used to annotate annotations that are to be used for Test Class fields.
Used to annotate annotations that are to be used for Test Class fields.
Specifies the supported browser types for Local and remote versions
Create a Start of Field position, represents to SF order
Obtain a
IBundleResources object for this test classRepresents a CICS TS region that has been provisioned for the test
A zOS 3270 Terminal for use with a CICS TS Region that has access to the default CICS screens
CICS TS wrapper class to HashMap to provide additional
functionality for use with CECI, CEMT and CEDA
Used to annotate annotations that are to be used for Test Class fields.
Cloud Container
The Cloud Container provides the ability to integration test applications across one or more cloud platforms.
Cloud Container - Environment Properties
If any environment properties are required to be passed to the container at startup, they can be specified via here.
Cloud Container - Port
A Port to be exposed from the Cloud Container.
Annotation to capture the other cloud related annotations from the test class
Continue On Test Failure will instruct Galasa that the event
of a test method failure, the test will containue to run.
Fill this field with the Core Manager instance.
Used to annotate annotations that are to be used for Test Class fields.
Utility methods for retrieving properties from the Configuration Property
Store.
Db2 Instance
Annotation to capture the other db2 realted annotations from the test class
Db2 Schema
Dex represents the dex gRPC service.
Dex represents the dex gRPC service.
A stub to allow clients to do synchronous rpc calls to service Dex.
A stub to allow clients to do ListenableFuture-style rpc calls to service Dex.
Base class for the server implementation of the service Dex.
A stub to allow clients to do asynchronous rpc calls to service Dex.
Client represents an OAuth2 client.
Client represents an OAuth2 client.
CreateClientReq is a request to make a client.
CreateClientReq is a request to make a client.
CreateClientResp returns the response from creating a client.
CreateClientResp returns the response from creating a client.
CreatePasswordReq is a request to make a password.
CreatePasswordReq is a request to make a password.
CreatePasswordResp returns the response from creating a password.
CreatePasswordResp returns the response from creating a password.
DeleteClientReq is a request to delete a client.
DeleteClientReq is a request to delete a client.
DeleteClientResp determines if the client is deleted successfully.
DeleteClientResp determines if the client is deleted successfully.
DeletePasswordReq is a request to delete a password.
DeletePasswordReq is a request to delete a password.
DeletePasswordResp returns the response from deleting a password.
DeletePasswordResp returns the response from deleting a password.
GetClientReq is a request to retrieve client details.
GetClientReq is a request to retrieve client details.
GetClientResp returns the client details.
GetClientResp returns the client details.
ListPasswordReq is a request to enumerate passwords.
ListPasswordReq is a request to enumerate passwords.
ListPasswordResp returns a list of passwords.
ListPasswordResp returns a list of passwords.
ListRefreshReq is a request to enumerate the refresh tokens of a user.
ListRefreshReq is a request to enumerate the refresh tokens of a user.
ListRefreshResp returns a list of refresh tokens for a user.
ListRefreshResp returns a list of refresh tokens for a user.
Password is an email for password mapping managed by the storage.
Password is an email for password mapping managed by the storage.
RefreshTokenRef contains the metadata for a refresh token that is managed by the storage.
RefreshTokenRef contains the metadata for a refresh token that is managed by the storage.
RevokeRefreshReq is a request to revoke the refresh token of the user-client pair.
RevokeRefreshReq is a request to revoke the refresh token of the user-client pair.
RevokeRefreshResp determines if the refresh token is revoked successfully.
RevokeRefreshResp determines if the refresh token is revoked successfully.
UpdateClientReq is a request to update an existing client.
UpdateClientReq is a request to update an existing client.
UpdateClientResp returns the response from updating a client.
UpdateClientResp returns the response from updating a client.
UpdatePasswordReq is a request to modify an existing password.
UpdatePasswordReq is a request to modify an existing password.
UpdatePasswordResp returns the response from modifying an existing password.
UpdatePasswordResp returns the response from modifying an existing password.
Protobuf type
api.VerifyPasswordReqProtobuf type
api.VerifyPasswordReqProtobuf type
api.VerifyPasswordRespProtobuf type
api.VerifyPasswordResp
VersionReq is a request to fetch version info.
VersionReq is a request to fetch version info.
VersionResp holds the version info of components.
VersionResp holds the version info of components.
Docker Container
Docker Container Configuation
Docker Volume
This DSS action request that a NEW property is added to the DSS.
This DSS action request that a property is deleted.
This DSS action request that all properties with this prefix are deleted.
This action is for the framework status area of Manager.
This action is for the framework status area of Manager.
This action is for the framework status area of Manager.
This action is for the framework status area of Manager.
This action is for the framework status area of Manager.
This DSS action request that property is swapped with another value.
This DSS action request that property is updated in the DSS whether it exists or not.
Types of Endpoints for the Galasa Ecosystem
An interface through which we can get environment variable values.
An interface through which we can get environment variable values.
A class to define all environment variables used in the Galasa API server.
Pojo to contain the onscreen contents.
Exceptions types which support it have more detail than just a string message.
An exception which also holds a FrameworkErrorCode to provide more fine-grained detail about the problem
being raised/thrown, which is programmatically accessible.
Used by Galasa as an out of the box key value store.
This class provides the Resource pooling service to the framework.
Annotation to identify manager controlled annotated fields
An abstract class containing the base methods used to validate Galasa resources.
A class which represents the gherkin feature.
A GherkinMethod is really a Gherkin Scenario.
A GherkinStatement is a single executable statement.
A GherkinTest is a complete Gherkin feature.
Run the supplied test class
This annotation will cause the Manager to influence the "failed" result of the test based on
whether a GitHub issue is open or closed.
Used to annotate annotations that are to be used for Test Class fields.
Parametrisable representation of a response to an HTTP request.
HTTP DELETE method.
A simple enum consisting of all possible HTTP request methods.
Something which can extract annotations from something can be an AnnotationExtractor
This interface provides methods to register additional stores
used only by Galasa's API server and should server initialisation.
This is a very simple manager which provides access to objects to assist in
retrieving artifacts/resources from the 'resources' directory in your test
bundle, and manipulating those resources
Allows for some control over loading extra bundles, and seeing if bundles are already loaded.
CICS/TS Command-level Interpreter (CECI) Interface.
Provides the SPI access to the CICS/TS CECI Manager
Provides CICS Region related CECI objects
Represents the response from a CECI command
Represents the value of an output field returned as the response from a CECI request.
Provides the SPI access to the CICS/TS CEDA Manager
Provides CICS Region related CEDA objects
Provides CICS Region related CEMTobjects
Used by the Galasa Framework to initialise the various the certificate store
if a non FPF certificate store is defined.
The Certificate store service will only be initialised if there is a defined
certificate store that is a non local file.
A Options pass through interface for the Selenium Options object
Represents a CICS Bundle resource.
Represents a CICS Resource.
Provides CICS Region related ICicsResource objects
Cloud Container
Interface from the Cloud Manager to Cloud Container Providers
SPI for the Cloud Manager
The confidential text services provides a manager with the ability to
registered passwords, usernames, keys and other confidnetial texts so that
they can be obscured inside logs and outputs.
The confidential text services provides a manager with the ability to
registered passwords, usernames, keys and other confidnetial texts so that
they can be obscured inside logs and outputs.
Represents a ConfigMap resource
Used by the Galasa Framework to initialise the various Configuration Property
Stores that may exist within the OSGi instance.
Used to gain access to properties in the Configuration Property Store
The Core Manager provides Tests with access to some of the most common
features within the Galasa Framework
To gain access to the Core Manager, include the following in the test class:-
IDb2Instance provides a connection to a tagged Db2 Database.
Db2 Manager SPI
Provides either a connection to a DB or a simple connection to a schema within the DB.
IDb2Schema provides a connection to a specific db2 schema.
Represent a Deployment resource
Docker Container Resource Object
Provides a resource object representing a Docker Container on a Docker
Engine.
An interface for the annotation object that represents the configurations for a container.
Docker Exec Resource Object that represents a command being executed on the
container.
A Galasa object to track, bind and provision Docker volumes with.
IDssAction is the basis for all updates to the Dynamic Status Store properties
IDssStatusAction is the basis for all updates to the Dynamic Status Store properties
framework status area
This interface will allow managers and services to update the a dynamic
resource view maintained by the framework.
Manager and services use this interface to update the status of a Run within
the Automation Views.
Used by the Galasa Framework to initialise the various Dynamic Status Stores
that may exist within the OSGi instance.
Used to gain access to properties in the Dynamic Status Store
Used to gain access to properties in the Dynamic Status Store
A Options pass through interface for the Selenium Options object
Represents the fields in the CICS/TS EXEC Interface Block (EIB).
A Options pass through interface for the Selenium Options object
IFramework provides access to the services the Framework specifically
controls, although will be provided by other OSGi bundles.
IFrameworkInitialisation provides access to the framework routines that
should only be called during test run and server initialisation.
Generic Ecosystem TPI
Provides a means to manipulate the ecosystem
Provides test code access to HTTP Manager to execute HTTP requests
An interface for auth token beans used internally to implement.
An interface for user beans used internally to implement.
A Options pass through interface for the Selenium Options object
Represents a IP Host or Stack.
Represents a IP Port.
Represents a Java installation on a Ubuntu image .
Represents a Java installation on a Windows image .
Interface for creation, management, deletion of JMeter sessions
Represents a CICS JVM server JVM profile
Represents a CICS JVM server resource.
A class to represent a Java Keystore and allow for easy appending and generation
Kubernetes Ecosystem TPI
Provides access to the ecosystem endpoints and provides the mean to manipulate the ecosystem
Provides the SPI for the Kubernetes Manager for Manager to Manager communication.
This is the main interface to a provisioned Kubernetes namespace on an infrastructure cluster.
Represents a Linux Image .
Kubernetes Ecosystem TPI
Provides access to the ecosystem endpoints and provides the mean to manipulate the ecosystem
This is the interface used by the Logging Managers to get test information
from the active managers.
Provides utility text scanning routines for tests and Managers to use, intended for use with logs or batch jobs etc.
This is the main interface used by the Framework to drive the Manager
lifecycle.
Represents a PersistentVolumeClaim
Holder for a Pod Log
Represents a resource that utilises ReplicatSets, ie Deployment and StatefulSet
Abstracts a Kubernetes Resource, so that the test is not dependent of whatever Kubernetes client the
Kubernetes Manager decides to use.
Used to gain access to the Result Archive Store (RAS)
Used by the Galasa Framework to initialise the various Result Archive Stores
that may exist within the OSGi instance.
A simple interface to provide easy access to multiple types of returns.
IRoute provides methods for endpoints to implement when a request is sent through a servlet,
allowing for new routes to be added without needing servlets to know which route handles the request.
Represents a RSE API server
Enumeration of RSE API request types
Provides the test code access to the RSE API Manager
Provides the SPI access to the RSE API Manager
Represents the response from a RSE API server request
This class provides the interface for
SDVUserImpl.
Represents a Secret resource
Deprecated.
Represents a Service resource
Represents a StatefulSet resource
This interface provides a access to a text resource that can be repeatedly updated and scanned for text.
Provides utility text scanning routines for tests and Managers to use, intended for use with logs or batch jobs etc.
An interface to allow the mocking of time-related method calls.
TPI for the WebPageImpl object provisioned by the Selenium Manager
Represents a Windows Image .
Provides the test code access to zOS Batch jobs via the zOS Manager
Represents a zOS Batch Job.
Represents a privovision zOS Batch Jobname
Represents a zOS Batch Job output
SPI to zOS Batch Job output
Represents the a spool file from a zOS Batch job
SPI interface to
IZosBatchProvides the test code access to the zOS Console via the zOS Manager
Represents a zOS Console Command.
When the command is issued via
When the command is issued via
IZosConsole.issueCommand(String) or IZosConsole.issueCommand(String, String), the immediate response message,
if available, together with a command response key, is received from the zOS Console.SPI interface to
IZosConsoleRepresentation of a non-VSAM data set
Enumeration of data type for store and retrieve of data set content:
IZosDataset.DatasetDataType.TEXT
IZosDataset.DatasetDataType.BINARY
IZosDataset.DatasetDataType.RECORDEnumeration of data set organization options:
IZosDataset.DatasetOrganization.PARTITIONED
IZosDataset.DatasetOrganization.SEQUENTIALEnumeration of space units for data set allocation:
IZosDataset.SpaceUnit.TRACKS
IZosDataset.SpaceUnit.CYLINDERS
Tester facing interface for zOS file management.
Represents a zOS Image (or lpar).
Create a new zOS Liberty server
Represents a zOS Liberty angel process
SPI interface to
IZosLibertyAngelRepresents a zOS Liberty server
An IZosLibertyServerLogs contain an array of Liberty server logs
Represents the server.xml configuration file in a zOS Liberty Server.
An IZosLibertyServerXmlElementList contains a list of XML elements
SPI interface to
IZosLibertyProvides the test code access to the zOS Manager
Represents a zOSMF server
Enumeration of zOSMF Custom HTTP headers
Enumeration of zOSMF request types
Provides the test code access to the zOSMF Manager
Provides the SPI access to the zOSMF Manager
Represents the response from a zOSMF server request
Represents a zOS Program
Provides the SPI access to the zOS Program Manager
Provides the test code access to zOS TSO Commands via the zOS Manager
SPI interface to
IZosTSOCommandProvides the test code access to zOS UNIX Commands via the zOS Manager
SPI interface to
IZosUNIXCommandRepresentation of a UNIX file or directory.
Enumeration of data type for store and retrieve of data set content:
IZosUNIXFile.UNIXFileDataType.TEXT
IZosUNIXFile.UNIXFileDataType.BINARYEnumeration of zOS UNIX file types:
IZosUNIXFile.UNIXFileType.FILE
IZosUNIXFile.UNIXFileType.CHARACTER
IZosUNIXFile.UNIXFileType.DIRECTORY
IZosUNIXFile.UNIXFileType.EXTLINK
IZosUNIXFile.UNIXFileType.SYMBLINK
IZosUNIXFile.UNIXFileType.FIFO
IZosUNIXFile.UNIXFileType.SOCKET
IZosUNIXFile.UNIXFileType.UNKNOWNHighly configurable representation of a VSAM dataset
Backup-While-Open options for VSAM define
VSAM Dataset Organisation options
Erase options for VSAM define
FR Log options for VSAM define
Log options for VSAM define
Recatalog options for VSAM define
Reuse options for VSAM define
Spanned options for VSAM define
Speed or Recovery options for VSAM define
Space units for VSAM define
Write check options for VSAM define
Used to annotate annotations that are to be used for Test Class fields.
Represents a Java installation on a Ubuntu image
Used to annotate annotations that are to be used for Test Class fields.
Represents a Java installation on a Windows image
Used to annotate annotations that are to be used for Test Class fields.
Kubernetes Ecosystem
Kubernetes Namespace
Represents a Linux that has been provisioned for the test
Represents a IP Host for a Linux Image that has been provisioned for the test
Used to annotate annotations that are to be used for Test Class fields.
Local Ecosystem
Fill this field with the Logger instance for this Test Class.
Fill this field with a Log Scanner object.
Used to annotate annotations that are to be used for Test Class fields.
Implementation of
IZosConsoleCommand using oeconsolImplementation of
IZosConsole using zOS/MFzOS Console Manager implemented using zOS/MF
Give this parse tree navigator a sub-visitor, and it will handle the visiting of all children
for all types of things for you, and call teh sub-visitor pre- during- and post- encountering
a node in the parse tree, as it navigates around.
Visits a parse tree, and populates the meaning into a test structure.
Anything interested in visiting the parse implements this interface.
A base class which implements the interface for visiting a parse tree.
A visitor of the parse tree which can turn an entire parse tree into a single string,
for easy output or comparing against test data.
A wrapper for a map of query parameters, with methods for extracting
and verifying the parameter contents.
An internal bean class representing a page of runs stored in the RAS,
which includes a token pointing to the next page of runs for
cursor-based pagination
A class which can validate whether a resources use valid characters or not.
Fill this field with a unique (within the ecosystem) string of a set length.
For use with the dummy RAS file system
For use with the dummy RAS file system
Dummy Byte Channel for a null Result Archive Store
Used to set the File Type for a Stored Artifact in the Result Archive Store
Dummy File Store if needed
Create a Result Archive Store specific File System
Dummy RAS provider to be extended by other RAS services
Create a Result Archive Store specific version of the Path
RSE API
Fill this field with the name of the Test Run.
Screen representation of the 3270 terminal
This class provides a generic Exception which can be thrown
throughout the SDV Manager.
Used to annotate annotations that are to be used for Test Class fields.
A zOS User that will have SDV recording switched on, on a specified CICS TS Region.
Deprecated.
Indicates that this Class setups up and validates a Shared Environment.
SSH client for Galasa
zOS Command exception indicating an error in SSH
This is a class to allow the HTTP manager implementations be used without the need for the manager to be active
Fill this field Root path of the Stored Artifacts for this Test Run.
An internal bean class containing the details required to submit a test run to the Galasa framework.
Provides a summary text to add to the test catalog
An implementation of the Environment interface which allows code to get
environment variables from the real system.
An implementation of the Environment interface which allows code to get
environment variables from the real system.
Used to tag a test.
Pojo to contain a set of terminal images.
Pojo to represent a Field on the terminal screen.
Pojo to represent a screen image as received or sent from the client.
Handles the writing of a terminal into a json string or json object.
Represents the terminal screen size
@Test annotation
Used to indicate what areas the test exercises.
Paired with ITestCatalogBuilder, classes annotated with this will be called
during the test catalog build process to append information to the test class
entry, and the overall test catalog json file.
Representation of the test class
Fill this field a test property from the Configuration Property Store
Represents a possible state of a test run.
Run the supplied test class
This class represents the Test Class structure, ie it's test methods, order
of execution and their status
Indicates this test has variations that will be entered into the Test Catalog
Provide a CPS property to set for a test variation
Indicates the test has multiple Test Variations
Used to annotate annotations that are to be used for Test Class fields.
Fill this field with a Text Scanner object.
A class that represents the payload of a POST request to an OpenID
Connect provider's token endpoint.
Represents a Windows that has been provisioned for the test
Represents a IP Host for a Windows Image that has been provisioned for the test
Used to annotate annotations that are to be used for Test Class fields.
Represents a zOS 3270 terminal that has been provisioned for the test
z/OS Batch
Used to annotate annotations that are to be used for Test Class fields.
Provides overrides for the Jobcard for jobs submitted via the Batch Manager.
z/OS Batch Jobname
z/OS Console
Used to annotate annotations that are to be used for Test Class fields.
Used to annotate annotations that are to be used for Test Class fields.
z/OS File
Represents a zOS Image that has been provisioned for the test
Used to annotate annotations that are a dependency of a zosImage, requires a imageTag for the zOS Manager to automatically provision the zOS Image
Represents a IP Host for a zOS Image that has been provisioned for the test
Represents a provisioned IP Port for a zOS Image that has been provisioned for the test
z/OS Liberty
z/OS Liberty Angel
Used to annotate annotations that are to be used for Test Class fields.
z/OS MF
z/OS Program
Enumeration of supported languages
z/OS TSO Command
Used to annotate annotations that are to be used for Test Class fields.
z/OS UNIX Command
Used to annotate annotations that are to be used for Test Class fields.