public class RestApiProxy extends ApplicationProxy
Each REST API deployed to an execution group can be represented by an RestApiProxy.
In order to use RestApiProxy objects, applications must first obtain handles to them. Here is an example of how to do this:
BrokerProxy b = BrokerProxy.getInstance( new IntegrationNodeConnectionParameters("localhost", 4414)); ExecutionGroupProxy e = b.getExecutionGroupByName("default"); RestApiProxy restapi = e.getRestApiByName("restapi1");
com.ibm.broker.config.proxy.RestApiProxy extends
com.ibm.broker.config.proxy.ApplicationProxy implements
com.ibm.broker.config.proxy.DeployedObjectGroupProxy implements
com.ibm.broker.config.proxy.DeployedObject
|
|
Responsibilities | Acts as a container of deployed message flows. Provides the ability to deploy information to the REST API represented by each instance. |
Internal Collaborators | com.ibm.broker.config.proxy.MessageFlowProxy |
Change Activity: -------- ----------- ------------- ------------------------------------ Reason: Date: Originator: Comments: -------- ----------- ------------- ------------------------------------ xyzab 2015-01-18 SS1 v10 Release
ApplicationProxy.ServiceOverview
Modifier and Type | Field and Description |
---|---|
protected static java.lang.String |
copyright
IBM Copyright
|
protected static java.lang.String |
sccsid
Version information
|
cachedServiceOverview
baseRetryWaitTime, LOCAL_ATTRIBUTE_IDENTIFIER, maxRetries, objectUnavailable, owningPool, potentialNewSubcomponents, propertyUpdateLock, retryWaitTimeIncrement, subcomponentsToBeSubmittedForCreationInCurrentBatch, UUID_DELIMITER
BARNAME_KEYWORD, USAGE_KEYWORD, VERSION_KEYWORD
Modifier | Constructor and Description |
---|---|
protected |
RestApiProxy(com.ibm.broker.config.proxy.AdministeredObjectPool aop)
DO NOT USE THIS CONSTRUCTOR - use
ExecutionGroupProxy.getRestApiByName(String) instead.
|
Modifier and Type | Method and Description |
---|---|
protected java.util.Properties |
getAdvancedProperties(boolean waitIfNotUpdated)
Returns a filtered list of the properties table associated with the
current object, removing any basic properties.
|
com.ibm.broker.rest.Api |
getApi()
Get the details of the API implemented by this REST API.
|
java.net.URL |
getBaseURL()
Returns the URL of the base of this REST API.
|
protected java.util.Properties |
getBasicProperties(boolean waitIfNotUpdated)
Returns a filtered list of the properties table associated with the
current object, filtered to basic properties only.
|
ConfigurationObjectType |
getConfigurationObjectType()
Returns the ConfigurationObjectType associated
with this AdministeredObject type.
|
java.net.URL |
getDefinitionsURL()
Returns the URL of the REST API definitions for this REST API.
|
java.lang.String |
getFileExtension()
Returns the file extension relevant to REST APIs, not
preceded by a '.' character.
|
java.net.URL |
getLocalBaseURL()
Returns the local URL (the host name is set to localhost) of the base of this REST API.
|
java.net.URL |
getLocalDefinitionsURL()
Returns the local URL (the host name is set to localhost) of the REST API definitions for this REST API.
|
com.ibm.broker.rest.Operation |
getOperation(java.lang.String operationName)
Get an operation from the REST API definitions using the name of that operation.
|
java.util.List<com.ibm.broker.rest.Operation> |
getOperations()
Get a list of all the operations that are defined in the REST API definitions.
|
protected java.lang.String |
getRuntimePropertyFolder()
Returns the runtime property folder for this application type.
|
boolean |
isOperationImplemented(java.lang.String operationName)
Determine whether or not an operation has been implemented.
|
static java.util.Properties |
withName(java.lang.String name)
Returns a new Properties object that has the name attribute set
to the supplied String, and the type attribute to be the name of
the subclass of AdministeredObject being used.
|
static java.util.Properties |
withUUID(java.lang.String uuid)
Returns a new Properties object that has the UUID attribute set
to the supplied String, and the type attribute to be the name of
the subclass of AdministeredObject being used.
|
clearRecordedTestData, deleteDeployedObjects, deleteDeployedObjectsByName, deploy, deploy, deploy, deploy, fullNameMatches, getBARFileName, getConfigurationObjectTypeOfParent, getDeployProperties, getDeployTime, getErrorHandlerNames, getExecutionGroup, getFullName, getInterfaceFiles, getInterfaceFilesAsZip, getKeywords, getKeywordValue, getLibraries, getLibrary, getLibraryByName, getMessageFlowByName, getModifyTime, getRuntimeProperty, getRuntimePropertyNames, getServiceDescriptor, getServiceInformation, getServiceName, getServiceOperation, getServiceOperations, getServiceQueryURL, getServiceURL, getSharedLibraryDependencies, getStartMode, getStaticLibraries, getStaticLibrary, getStaticLibraryByName, getVersion, isJavaIsolated, isRunEnabled, isRunning, isServiceInternalComponent, setAllMessageFlowsRuntimeProperties, setAllMessageFlowsRuntimeProperty, setName, setRuntimeProperty, setStartMode, start, stop, stop
deploy, getDeployedObjectByName, getDeployedObjectFromSubcomponentString, getDeployedObjects, getDeployedObjects, getDeployedObjectsCount, getDeployedPolicySetBindingsNames, getDeployedPolicySetNames, getMessageFlow, getMessageFlowByName, getMessageFlowDependencies, getMessageFlows, getMessageSets, getNodeTypes, getQueues, getSubFlow, getSubFlowByName, getSubFlows, setUserTrace, startMessageFlows, stopMessageFlows, stopMessageFlows, stopMessageFlows
checkTypeAndBase64DecodePropertyValue, checkTypeAndBase64EncodePropertyValue, clearPredictedNewSubcomponents, createManagedSubcomponent, createManagedSubcomponent, createManagedSubcomponent, createManagedSubcomponent, deleteManagedSubcomponents, deregisterListener, deregisterListener, elements, equals, execute, getAdvancedProperties, getBasicProperties, getGrandParentUUIDProperties, getLastBIPMessages, getLastCompletionCode, getLastUpdateUser, getLongDescription, getManagedSubcomponent, getManagedSubcomponentFromStringRepresentation, getManagedSubcomponents, getManagedSubcomponents, getManagedSubcomponents, getManagedSubcomponents, getManagedSubcomponentsAsStrings, getManagedSubcomponentsAsStrings, getName, getNumberOfSubcomponents, getParent, getProperties, getProperties, getProperty, getProperty, getProperty, getProperty, getProperty, getPropertyBaseName, getPropertyInt, getPropertyInternal, getRefreshRequired, getRepositoryTimestamp, getShortDescription, getTimeOfLastCompletionCode, getTimeOfLastUpdate, getType, getUUID, getUUIDOfGrandParent, getUUIDOfParent, hasBeenPopulatedByBroker, hasBeenPopulatedByBroker, hasBeenPopulatedByBroker, hasBeenRestrictedByBroker, hasBeenRestrictedByBroker, hasBeenRestrictedByConfigManager, hasBeenRestrictedByConfigManager, hasBeenUpdatedByConfigManager, hasBeenUpdatedByConfigManager, isAUserDefinedObjectDestructor, isAwaitingSubmissionForCreation, isAwaitingSubmissionForDeletion, isDeployed, isLastPropertyIdentifier, isPartOfAPropertyGroup, isShared, predictPropertiesOfNewObject, refresh, refresh, registerListener, registerListener, registerListener, removeLocalProperty, setIsAwaitingSubmissionForCreation, setIsAwaitingSubmissionForDeletion, setLastBIPMessages, setLastCompletionCode, setLocalProperty, setLongDescription, setProperties, setProperties, setRefreshRequired, setShortDescription, setTimeOfLastUpdate, toString, toVerboseString, unsubscribeFromConfigurationManagerUpdates, validateObjectAndPropertyName, validateServiceObjectAndPropertyName
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getName
protected static final java.lang.String copyright
protected static final java.lang.String sccsid
protected RestApiProxy(com.ibm.broker.config.proxy.AdministeredObjectPool aop)
aop
- The pool that will own this object.public static java.util.Properties withUUID(java.lang.String uuid)
public static java.util.Properties withName(java.lang.String name)
public ConfigurationObjectType getConfigurationObjectType()
getConfigurationObjectType
in class ApplicationProxy
protected java.lang.String getRuntimePropertyFolder()
getRuntimePropertyFolder
in class ApplicationProxy
public java.lang.String getFileExtension()
getFileExtension
in interface DeployableObject
getFileExtension
in class ApplicationProxy
DeployableObject.getFileExtension()
protected java.util.Properties getBasicProperties(boolean waitIfNotUpdated) throws ConfigManagerProxyPropertyNotInitializedException
This method will pause until the object has received at least one update from the broker. If an update is not received before the timeout specified in BrokerProxy.setRetryCharacteristics() is reached, AdministeredObject.hasBeenPopulatedByBroker() will return false and the returned Properties object will contain a much smaller set of properties, that the IBM Integration API (CMP) has derived from other sources.
getBasicProperties
in class ApplicationProxy
waitIfNotUpdated
- Only if this value is true, the method
will pause until the object has received at least one update from
the broker. If an update is not received before the timeout specified
in BrokerProxy.setRetryCharacteristics() is reached,
AdministeredObject.hasBeenPopulatedByBroker() will return false and the returned
Properties object will contain a much smaller set of properties,
that the IBM Integration API (CMP) has derived from other
sources.ConfigManagerProxyPropertyNotInitializedException
protected java.util.Properties getAdvancedProperties(boolean waitIfNotUpdated) throws ConfigManagerProxyPropertyNotInitializedException
getAdvancedProperties
in class ApplicationProxy
waitIfNotUpdated
- Only if this value is true, the method
will pause until the object has received at least one update from
the broker. If an update is not received before the timeout specified
in BrokerProxy.setRetryCharacteristics() is reached,
AdministeredObject.hasBeenPopulatedByBroker() will return false and the returned
Properties object will contain a much smaller set of properties,
that the IBM Integration API (CMP) has derived from other
sources.ConfigManagerProxyPropertyNotInitializedException
public com.ibm.broker.rest.Api getApi() throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyLoggedException
- if the API details could not be retrieved for this REST API, or if those
API details could not be processed.ConfigManagerProxyPropertyNotInitializedException
- if the value of the field could not be determined because
the value has not yet been supplied to from the broker.public java.net.URL getLocalBaseURL() throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyLoggedException
- if the local URL of the base of this REST API could not be
retrieved, or is not a valid URL.ConfigManagerProxyPropertyNotInitializedException
- if the value of the field could not be determined because
the value has not yet been supplied to from the broker.public java.net.URL getBaseURL() throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyLoggedException
- if the URL of the base of this REST API could not be
retrieved, or is not a valid URL.ConfigManagerProxyPropertyNotInitializedException
- if the value of the field could not be determined because
the value has not yet been supplied to from the broker.public java.net.URL getLocalDefinitionsURL() throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyLoggedException
- if the local URL of the REST API definitions for this REST API could not be
retrieved, or is not a valid URL.ConfigManagerProxyPropertyNotInitializedException
- if the value of the field could not be determined because
the value has not yet been supplied to from the broker.public java.net.URL getDefinitionsURL() throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyLoggedException
- if the URL of the base of this REST API could not be
retrieved, or is not a valid URL.ConfigManagerProxyPropertyNotInitializedException
- if the value of the field could not be determined because
the value has not yet been supplied to from the broker.public java.util.List<com.ibm.broker.rest.Operation> getOperations() throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyLoggedException
- if the API details could not be retrieved for this REST API, or if those
API details could not be processed.ConfigManagerProxyPropertyNotInitializedException
- if the value of the field could not be determined because
the value has not yet been supplied to from the broker.public com.ibm.broker.rest.Operation getOperation(java.lang.String operationName) throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
operationName
- the name of the operation.ConfigManagerProxyLoggedException
- if the API details could not be retrieved for this REST API, or if those
API details could not be processed.ConfigManagerProxyPropertyNotInitializedException
- if the value of the field could not be determined because
the value has not yet been supplied to from the broker.public boolean isOperationImplemented(java.lang.String operationName) throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException
operationName
- the name of the operation to check.ConfigManagerProxyLoggedException
- if the API details could not be retrieved for this REST API, or if those
API details could not be processed.ConfigManagerProxyPropertyNotInitializedException
- if the value of the field could not be determined because
the value has not yet been supplied to from the broker.