com.ibm.broker.config.appdev

Class IntegrationService

  • java.lang.Object
    • com.ibm.broker.config.appdev.IntegrationService
    • Constructor Detail

      • IntegrationService

        public IntegrationService(java.io.File serviceDescriptorFile)
                           throws java.io.IOException,
                                  IntegrationServiceException
        Constructs a Broker service from a service descriptor file. It is expected that the referenced service WSDL and main message flow in the service descriptor file exist and are valid.
        Parameters:
        serviceDescriptorFile - Full path of the service.descriptor file
        Throws:
        java.io.IOException
        IntegrationServiceException
      • IntegrationService

        public IntegrationService(java.lang.String serviceName)
                           throws IntegrationServiceException
        Constructs a Broker service from scratch. It is the caller's responsibility to create valid service WSDL, main message flow and any operation subflows.
        Parameters:
        serviceName - Name of the integration service
        Throws:
        IntegrationServiceException
      • IntegrationService

        public IntegrationService(java.lang.String serviceName,
                                  java.lang.String wsdlFileName,
                                  java.lang.String serviceProjectPath)
                           throws java.io.IOException,
                                  IntegrationServiceException
        Constructs a Broker service from an existing WSDL. It is expected that the WSDL has been imported. The constructor will create the following: - a main message flow - error handling subflows
        Parameters:
        serviceName - Name of the integration service
        wsdlFileName - Full path of the WSDL file. The WSDL must have been imported.
        serviceProjectPath - Full path of the integration service project.
        Throws:
        IntegrationServiceException
        java.io.IOException
    • Method Detail

      • writeServiceDescriptor

        public void writeServiceDescriptor()
                                    throws java.io.IOException
        Throws:
        java.io.IOException
      • writeServiceDescriptor

        public void writeServiceDescriptor(java.lang.String brokerServiceFileName)
                                    throws java.io.IOException
        Throws:
        java.io.IOException
      • writeMainFlow

        public void writeMainFlow()
                           throws com.ibm.broker.MessageBrokerAPIException,
                                  java.io.IOException
        Throws:
        com.ibm.broker.MessageBrokerAPIException
        java.io.IOException
      • writeSubflow

        public void writeSubflow(MessageFlow subflow)
                          throws com.ibm.broker.MessageBrokerAPIException,
                                 java.io.IOException
        Throws:
        com.ibm.broker.MessageBrokerAPIException
        java.io.IOException
      • write

        public void write()
                   throws com.ibm.broker.MessageBrokerAPIException,
                          java.io.IOException
        Throws:
        com.ibm.broker.MessageBrokerAPIException
        java.io.IOException
      • toXML

        public org.w3c.dom.Element toXML()
      • generateJavaScriptAPIs

        public void generateJavaScriptAPIs(java.lang.String urlSuffix)
                                    throws IntegrationServiceException
        Generates a JSON/HTTP binding with the given HTTP URL suffix. The HTTP URL suffix must start with "/" and end with "/*". The URL suffix will be prepended to the service name to uniquely define the service path.
        Parameters:
        urlSuffix -
        Throws:
        IntegrationServiceException
      • setIntegrationServiceJavaProject

        public void setIntegrationServiceJavaProject(java.lang.String javaProjectPath,
                                                     java.lang.String sourceFolder)
        Sets the Java project path and source folder for the current integration service project. This setter ensures that the project path ends with a file separator.
      • setNeedErrorHandlers

        public void setNeedErrorHandlers(boolean needErrorHandlers)
      • setWSDL

        public void setWSDL(java.lang.String wsdlName)
        Sets the project-relative path (as string) of the service WSDL.
      • setMainFlowName

        public void setMainFlowName(java.lang.String mainFlowName)
        Sets the project-relative path (as string) of the main message flow.
      • setPortTypeName

        public void setPortTypeName(java.lang.String portTypeName)
        Sets the port type name of the Broker service.
      • getServiceName

        public java.lang.String getServiceName()
      • getWSDL

        public java.lang.String getWSDL()
      • getMainFlowName

        public java.lang.String getMainFlowName()
      • getWSDLService

        public com.ibm.broker.config.appdev.wsdl.TService getWSDLService()
      • getWSDLServiceQName

        public javax.xml.namespace.QName getWSDLServiceQName()
      • getWSDLServicePort

        public com.ibm.broker.config.appdev.wsdl.TPort getWSDLServicePort()
      • getServiceOperationsAsString

        public java.util.List<java.lang.String> getServiceOperationsAsString()
      • getSOAPURLPathSuffix

        public java.lang.String getSOAPURLPathSuffix()
        Returns the SOAP URL path suffix.
      • getHTTPURLPathSuffix

        public java.lang.String getHTTPURLPathSuffix()
        Returns the HTTP URL path suffix.