com.ibm.zosconnect.buildtoolkit
Interface SARGeneratorPlugin
-
public interface SARGeneratorPlugin
-
-
Field Summary
Fields Modifier and Type Field and Description static java.lang.String
copyright_notice
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description java.lang.String
getProviderName()
Supplies the unique name of the Service Provider that service archives are being built for.ProviderProperty[]
getProviderProperties()
Provides the configuration properties for the service represented by this service archive.java.lang.String
getRequestSchema()
Provides the request schema for the service represented by this service archive.java.lang.String
getResponseSchema()
Provides the response schema for the service represented by this service archive.ServiceArtifact[]
getSarContents()
Returns the other content that needs to be stored in the service archive.void
setParameters(java.util.Map<java.lang.String,java.lang.String> parameters)
Sets the configuration properties supplied by the user to be used in the creation of the service archive.
-
-
-
Field Detail
-
copyright_notice
static final java.lang.String copyright_notice
- See Also:
- Constant Field Values
-
-
Method Detail
-
getProviderName
java.lang.String getProviderName()
Supplies the unique name of the Service Provider that service archives are being built for.- Returns:
- A String containing the Service Provider unique name
-
getRequestSchema
java.lang.String getRequestSchema()
Provides the request schema for the service represented by this service archive.- Returns:
- A string containing the request JSON Schema.
-
getResponseSchema
java.lang.String getResponseSchema()
Provides the response schema for the service represented by this service archive.- Returns:
- A string containing the response JSON Schema.
-
getProviderProperties
ProviderProperty[] getProviderProperties()
Provides the configuration properties for the service represented by this service archive.- Returns:
- An array of
ProviderProperty
objects representing each property.
-
getSarContents
ServiceArtifact[] getSarContents() throws ServiceArtifactException
Returns the other content that needs to be stored in the service archive.- Returns:
- An array of
ServiceArtifact
objects representing each file. - Throws:
ServiceArtifactException
- If there is a problem creating one of the ServiceArtifacts
-
setParameters
void setParameters(java.util.Map<java.lang.String,java.lang.String> parameters) throws InvalidPropertyException
Sets the configuration properties supplied by the user to be used in the creation of the service archive.- Parameters:
parameters
- A Map of String to String mapping the property name to the supplied value.- Throws:
InvalidPropertyException
- If the plugin decides that one of the properties contains an invalid value.
-
-