Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space WBRIDGE and version 21.1.4

...

  1. Assigning the Diagram Name
  2. Defining the Composite
  3. Defining the Frontend Service
  4. Defining the SOAP Service Interface
  5. Defining Backend Aliases
  6. Finishing the Components Wizard

Step 1: Assigning the Diagram Name

After starting the Components Wizard, the first dialog opens, and you are prompted to enter the name of the component diagram.

Image Modified

You may use the suggested default name name suggested or enter a descriptive name. Changing the name will change the name of the top most tree node (marked in blue) in the navigation panel.

Click Next to proceed or Cancel to abort.

The Components Wizard can be canceled any time.

Image Modified

After clicking cancel, the Components Wizard prompts for confirmation.

Step 2: Defining the Composite

In With the next step, you will define the service composite. The service composite represents the repository of the Web service and will contain all necessary configuration information.

Clicking Next after assigning having assigned the diagram name will bring you directly to the following dialog. Create the service composite here.

Image Modified

Assign a name to the composite. In the field Control Port, enter an unused port number (the value needs to be between 20'000 and 29'999).

icon
Note
Info
false

Special characters and blanks are not allowed for composite names.

Image Modified

In case you accidentally clicked the Cancel button was accidentally pressed, the Create new Composite window can be re-opened by clicking the New button.

The Create New Composite dialog contains four more tabs.

Image Modified

On the Advanced tab of this dialog, you can

configure

the compiler as to create a WSDL per service
  • define the WSDL namespace
  • assign a category to the xUML service
  • select whether you want the compiler to resolve class inheritances when generating the WSDL file
    Bridge 7 Using this option is deprecated.
  • Bridge 7 specify a service version
    This service version will be visible in service context on the Bridge.
  • select the SOAP version of the service
  • specify a startup shutdown trace port

    advanced composite settings as tagged values to the composite.

    Tagged ValueDescription
    wsdlPerService

    Multiexcerpt include
    MultiExcerptNamewsdlPerService
    nopaneltrue
    PageWithExcerptFrontend Components

    WSDL Namespace

    Multiexcerpt include
    MultiExcerptNamewsdlNamespace
    nopaneltrue
    PageWithExcerptFrontend Components

    Category
    Multiexcerpt include
    MultiExcerptNamecategory
    nopaneltrue
    PageWithExcerptFrontend Components
    resolveInheritance
    Multiexcerpt include
    MultiExcerptNameresolveInheritance
    nopaneltrue
    PageWithExcerptFrontend Components
    Version
    Multiexcerpt include
    MultiExcerptNameversion
    nopaneltrue
    PageWithExcerptFrontend Components
    Soap Version

    Multiexcerpt include
    MultiExcerptNamesoapVersion
    nopaneltrue
    PageWithExcerptFrontend Components

    Class To XML Default Root Name
    Multiexcerpt include
    MultiExcerptNameclassToXMLDefaultRootName
    nopaneltrue
    PageWithExcerptFrontend Components

    Refer to XML - UML Class Mapping for more information on the topic of XML serialization.
    Startup Shutdown Trace Port

    Multiexcerpt include
    MultiExcerptNamestartupShutdownTracePort
    nopaneltrue
    PageWithExcerptFrontend Components

    For more information on these tagged values refer to Frontend Components .

    Image Modified

    Specify the test settings here.

    Tagged ValueDescription

    generateTestService

    Multiexcerpt include
    MultiExcerptNamegenerateTestService
    nopaneltrue
    PageWithExcerptUsing Testable Classes

    Test Service Name

    :

    Multiexcerpt include
    MultiExcerptNametestServiceName
    nopaneltrue
    PageWithExcerptUsing Testable Classes
    Test Port
    :
    Multiexcerpt include
    MultiExcerptNametestPort
    nopaneltrue
    PageWithExcerptUsing Testable Classes

    Test Encoding

    :

    Multiexcerpt include
    MultiExcerptNametestEncoding
    nopaneltrue
    PageWithExcerptUsing Testable Classes

    Test Proxy Host

    :

    Multiexcerpt include
    MultiExcerptNametestProxyHost
    nopaneltrue
    PageWithExcerptUsing Testable Classes
    Test Proxy Port
    :
    Multiexcerpt include
    MultiExcerptNametestProxyPort
    nopaneltrue
    PageWithExcerptUsing Testable Classes
    Test Proxy Protocol
    :
    Multiexcerpt include
    MultiExcerptNametestProxyProtocol
    nopaneltrue
    PageWithExcerptUsing Testable Classes
    Test Proxy Path
    :
    Multiexcerpt include
    MultiExcerptNametestProxyPath
    nopaneltrue
    PageWithExcerptUsing Testable Classes
    External Test Proxy Host
    :
    Multiexcerpt include
    MultiExcerptNameexternalTestProxyHost
    nopaneltrue
    PageWithExcerptUsing Testable Classes

    For more information on testing in general refer to QA Concepts.

    Image Modified

    Using Persistent State features in the xUML service, you can make corresponding adjustments on the Persistent State tab configuring , and configure the persistent state engine.

    Tagged ValueDescription
    Workers
    Multiexcerpt include
    MultiExcerptNameworkers
    nopaneltrue
    PageWithExcerptPersistent State Components
    Storage Medium
    Multiexcerpt include
    MultiExcerptNamestorageMedium
    nopaneltrue
    PageWithExcerptPersistent State Components
    Internal State Database Sync
    Multiexcerpt include
    MultiExcerptNamestate_db_synch
    nopaneltrue
    PageWithExcerptPersistent State Components
    External Database Alias
    Multiexcerpt include
    MultiExcerptNameexternalStateDBAlias
    nopaneltrue
    PageWithExcerptPersistent State Components
    Owner

    Owner specifies the owner of the persistent state objects. Default owner (used when no divergent owner is specified) is the xUML service name, which is unique on each node instance.

    Switch Over Enabled
    Multiexcerpt include
    MultiExcerptNameswitchOverRetryTimeout
    nopaneltrue
    PageWithExcerptPersistent State Components
    Switch Over Retry Timeout
    Multiexcerpt include
    MultiExcerptNameswitchOverEnabled
    nopaneltrue
    PageWithExcerptPersistent State Components
    Event Selection Algorithm
    Multiexcerpt include
    MultiExcerptName
    event_selection_algorithm
    nopaneltrue
    PageWithExcerptPersistent State Components
    External Properties State DB Alias
    Multiexcerpt include
    MultiExcerptNameexternalPropertiesStateDBAlias
    switchOverRetryTimeout
    nopaneltrue
    PageWithExcerptPersistent State Components

    For more information Persistent State Components.

    Image Modified

    Using Java services in the xUML service, you can specify the JVM options here.

    Tagged ValueDescription

    JVM Options

    :

    Multiexcerpt include
    MultiExcerptNamejvmOptions
    nopaneltrue
    PageWithExcerptModeling the Java Components
    killJVMThreadsOnShutdown
    :
    Multiexcerpt include
    MultiExcerptNamekillJVMThreadsOnShutdown
    nopaneltrue
    PageWithExcerptModeling the Java Components
    Parallel JVM Operations
    :
    Multiexcerpt include
    MultiExcerptNameparallelJVMOperations
    nopaneltrue
    PageWithExcerptModeling the Java Components

    For more information on Java Components refer to Modeling the Java Components.

    ...

    Up to this point, you have defined the xUML service component EducationLesson3.

    Image Modified

    In the customization panel, you will can find the new xUML service component (e.g. EducationLesson3) in the list of added composites on the right side.

    Info
    iconfalse

    The left side of the customization panel contains available components, classes, or interfaces. The right side always contains the used components.

    Click Next to proceed.

    Step 3: Defining the Frontend Service

    In the next step, you define the frontend service that will be part of the xUML service.

    ...

    Clicking Next after having defined the composite will bring you directly to the following dialog. Add a frontend service here.

    Image Modified

    Select a service type from the list.

    Image Modified

    In other cases, e.g. if you want to add additional services, you can open the above dialog by clicking New on Services level of the tree.

    ...

    • E2EEventObserverService
    • E2EHTTPService
    • E2EJavaService
    • E2ESAPRFCService
    • E2ESchedulerService
    • E2ESOAPService
    • E2ETimerService
    • several ActiveMQ versions
    • GlassFishMQ-4.4
    • Weblogic-10.3
    • WebshpereMQ-6-NoJNDI
    • WebshpereMQ-7
    • XSLTProcessor
    • ApacheFOP
    • Saxon6 and 8
    • Xalan2
    • XalanTrax2
    • UIRepository

    Image Modified

    This example shows how to define a Web service. Select the service stereotype E2ESOAPService.

    Proceed with OK.

    Image Modified

    Now, customize the service artifact.

    Tagged ValueDescription

    Name

    Assign a Name.

    Port

    Assign a Port, to which the SOAP service is listening (the value needs to be between 10'000 and 19'999).

    Encoding

    Select an encoding. See Encoding of SOAP Operations for more information on SOAP encoding

    and the E2E Bridge

    of xUML services.

    Timezone

    :

    Multiexcerpt include
    MultiExcerptNametimezone
    nopaneltrue
    PageWithExcerptSOAP Service Reference
    Date Format String
    :
    Multiexcerpt include
    MultiExcerptNamedateFormatString
    nopaneltrue
    PageWithExcerptSOAP Service Reference
    Max Request Body Size
    Multiexcerpt include
    SpaceWithExcerptINTERNAL
    MultiExcerptNamemax_request_body_size
    PageWithExcerptINTERNAL:_bridge_excerpts
    Max Parallel ConnectionsMaximum number of requests that can be processed in parallel.
    resolveHostnamesAutomatically resolve IP addresses to domain names.

    The Create New SOAP Service dialog contains two more tabs.

    Image Modified

    On the Advanced tab, you can specify the following settings:

    Tagged ValueDescription
    Wsdl Namespace
    :
    Multiexcerpt include
    MultiExcerptNamewsdlNamespace
    nopaneltrue
    PageWithExcerptSOAP Service Reference
    Authentication Mode
    :
    Multiexcerpt include
    MultiExcerptNameauthenticationMode
    nopaneltrue
    PageWithExcerptSOAP Service Reference

    User

    :

    Specifies user and password for the use of HTTP Basic authentication.

    For detailed information on these tagged values refer to SOAP Service Reference.

    Anchor
    proxy_tab
    proxy_tab
    Image Modified

    On the Proxy tab, you can specify the proxy details.

    Tagged ValueDescription
    External Proxy Host
    :
    Multiexcerpt include
    MultiExcerptName
    proxyHost
    externalProxyHost
    nopaneltrue
    PageWithExcerptSOAP Service Reference
    Proxy
    Path:
    Host
    Multiexcerpt include
    MultiExcerptName
    proxyPath
    proxyHost
    nopaneltrue
    PageWithExcerptSOAP Service Reference

    Proxy

    Protocol:

    Path

    Multiexcerpt include
    MultiExcerptName
    proxyProtocol
    proxyPath
    nopaneltrue
    PageWithExcerptSOAP Service Reference
    Proxy Port
    :
    Multiexcerpt include
    MultiExcerptNameproxyPort
    nopaneltrue
    PageWithExcerptSOAP Service Reference
    External
    Proxy
    Host:
    Protocol
    Multiexcerpt include
    MultiExcerptName
    externalProxyHost
    proxyProtocol
    nopaneltrue
    PageWithExcerptSOAP Service Reference

    For detailed information on these tagged values refer to SOAP Service Reference.

    ...

    Now, in the component diagram the service component is placed within the service composite component.

    Image Modified

    In the customization panel on the right, you will find the new service (e.g. QueryProductsService).

    Click Next to proceed.

    Step 4: Defining the SOAP Service Interface

    In the next step, you will define the interface of the SOAP service. Through this interface, the Web service is accessible from the outside world.

    Image Modified

    The Components Wizard lists all port type classes on the left. Select a port type and click the button  >  to click Add to add the port type to the composite.

    Image Modified

    In the following dialog, assign a name to the port type or use the default name suggested.

    Noteinfo
    iconfalse

    Special characters and blanks are not allowed for component names.

    • Provide a Namespace if necessary.
    • Provide a path, if you want to make this component independent of the package structure. Without a given path, port types are identified by port type name and package URL.

    Proceed with OK.


    Image Modified

    In the artifact part oft the customization panel, you will find the added port type QueryProductsPortType .

    As an interface can only be used once in a composite, the port type QueryProductsPortType is not displayed anymore in the SOAP Port Types list on the left.

    Noteinfo
    iconfalse

    Each port type class (representing the interface of the SOAP service) can only be used once in a composite.

    Click Next to proceed.


    Image Modified

    In the Customized Artifacts part of the tree panel, the xUML service is selected again , to give you the option to define further frontend services (see Defining the Frontend Service).

    If you do not need any further elements, click Skip.

    For definition of Backend Services (Aliases/Resources) see below (Defining Backend Aliases).

    For Finishing the Components Wizard see Finishing the Components Wizard.

    Step 5: Defining Backend Aliases

    In this step, backend aliases are defined. The Components Wizard provides predefined Backend Components.

    Image Modified

    Click New to create a new backend alias ...

    Image Modified

    ...or select an existing alias and click > click Add to add it to the component diagram.

    ...

    Choose a backend alias stereotype from the list of available stereotypes, e.g. FileSystemAlias FileAlias and click OK.

    Image Modified

    Assign a name to the alias or leave the default name suggested.

    Specify File Name and Path, or, if you wanted to read data from an imported resource, select the resource from the Resource drop-down box instead.

    Click OK.

    Image Modified

    In right part oft the customization panel, you will find the new file system alias (e.g. ProductCatalog).

    Click Next.

    Step 6: Finishing the Components Wizard

    This is the final step of the Components Wizard . You need to where you confirm to draw the component diagram. If the definitions are not complete yet, you may can select an element node in the tree panel and add further UML elements to the diagram.

    ...