Creating POJO Service Engine Projects

The POJO Service Engine offers a variety of methods to create service providers and consumers using the NetBeans IDE. You can create providers and consumers with or without binding definitions (WSDL documents), and you can create providers from a wizard or from the Java Editor Palette. Consumers can also be created from the Palette.

Perform any of the following steps to create POJO service providers and consumers:

• Creating a POJO Service Provider (Without Binding)

• Creating a POJO Service Provider (With Binding)

• Creating a POJO Service Provider in an Existing Java Application

• Creating a POJO Service Consumer (Without Binding)

• Creating a POJO Service Consumer (With Binding)

Creating a POJO Service Provider (Without Binding)

This procedure creates a framework in a Java file for a POJO service provider using a wizard that guides you through the steps. The framework includes annotations and standard methods, and you can customize this framework to define the logic of the service. There is no WSDL document or binding involved in this procedure; a binding can be added when you create the composite application.

To Create a POJO Service Provider (Without Binding)

1. Right-click in the NetBeans Projects window, and then select New Project.

   The New Project Wizard appears.

2. Under Categories, select Java; under Projects, select Java Application.
   
3. Click Next.

   The Name and Location window appears.

4. Enter a unique name for the project and a name for the main Java package and class.
   
5. Click Finish.

   The project structure is generated and appears in the Projects window.

6. Right-click the project you just created, point to New, and then select Other.

   The New File Wizard appears.

7. Under Categories, select ESB; under Projects, select POJO Service.
   
8. Click Next.

   The Name and Location window appears.

9. Fill in the Name and Location properties for the POJO service.

   For more information, see Table 1.

10. To modify advanced properties for the POJO service, click Advanced.

    The POJO Provider – Advanced properties editor appears.

11. Modify any of the properties described in Table 2, and then click OK.
12. On the New POJO Service Wizard, click Finish.

    The new POJO class is generated in the project structure and any library JAR files needed to compile the project are added to the Libraries node of the project. The POJO file includes the @Provider, @Operation, and @Resource annotations.

    
    

Next Steps

For instructions on creating a composite application for this project, see Creating a Composite Application for a POJO Service Provider (Without Binding).

Creating a POJO Service Provider (With Binding)

This procedure creates a POJO service provider using a wizard to guide you through the steps. This wizard includes the steps for configuring the binding component for the service provider and automatically generates the WSDL file.

To Create a POJO Service Provider (With Binding)

1. Right-click in the NetBeans Projects window, and then select New Project.

   The New Project Wizard appears.

2. Under Categories, select Java; under Projects, select Java Application.
   
3. Click Next.

   The Name and Location window appears.

4. Enter a unique name for the project and a name for the main Java package and class.
   
5. Click Finish.

   The project structure is generated and appears in the Projects window.

   
   
6. Right-click the project you just created, point to New, and then select Other.

   The New File Wizard appears.

7. Under Categories, select ESB; under Projects, select POJO Service for Binding.
   
8. Click Next.

   The Name and Location window for the WSDL file appears.

9. Fill in the Name and Location properties for the POJO service.

   For more information, see Table 3.

   
   

   ---

   Note - The sequence of steps changes to reflect the binding component and type you choose. The subsequent steps will vary depending on those two properties.

   ---

10. Click Next.

    The binding configuration window appears.

11. Enter information about the binding component and type, and then click Next.

    ---

    Note - This page varies by binding component and type. For more information about a specific binding component, refer to the user's guide for that component or refer to the property descriptions at the bottom of the window. An example for the File Binding Component is shown below.

    ---

    
    
12. If a second page of binding configuration appears, enter the required information and then click Next.
13. On the Name and Location window for the POJO service, fill in the fields described in Table 1.
14. On the New POJO Service Wizard, click Finish.

    The new POJO class and WSDL file are generated in the project structure and any library JAR files needed to compile the project are added to the Libraries node of the project. The POJO file includes the @Provider, @Operation, and @Resource annotations.

    
    

Next Steps

For instructions on creating a composite application for this project, see Creating a Composite Application for a POJO Service Provider (With Binding).

Creating a POJO Service Provider in an Existing Java Application

This procedure creates a POJO service provider in an existing Java file using the Palette on the NetBeans Java Editor. Dragging and dropping a provider into the Java code creates a framework for the service provider, which you can then customize with the needed processing logic. There is no WSDL document or binding involved in this procedure; a binding can be added when you create the composite application.

To Create a POJO Service Provider in a Java Application

1. Open the Java file to which you want to add the POJO service provider.
2. If the Palette is not visible, click Window in the NetBeans toolbar and then click Palette.

   The Palette appears to the right of the Java Editor.

3. Drag and drop a POJO Provider from the Palette to the location in the Java file where you want to insert to POJO service provider.

   The Name and Location Wizard appears.

   
   
4. Enter the method name, input type, and return type.

   For more information about these fields, see Table 1.

5. To configure advanced properties, click Advanced.

   The Advanced properties editor appears.

6. Modify any of the properties described in Table 2.
7. Click Finish.

   Any library JAR files needed to compile the project are added to the Libraries node of the project. The @Provider, @Operation, and @Resource annotations are added at the insertion point.

   
   

Next Steps

For instructions on creating a composite application for this project, see Creating a Composite Application for a POJO Service Provider (Without Binding).

Creating a POJO Service Consumer (Without Binding)

This procedure creates a service consumer within an existing service provider definition. Dragging and dropping a consumer into the Java code creates a framework for the service consumer, which you can then customize with the needed processing logic. There is no WSDL document or binding involved in this procedure; a binding can be added when you create the composite application.

To Create a POJO Service Consumer (Without Binding)

Before You Begin

The POJO service consumer can only be added within an existing provider. Make sure you have a provider defined in the Java class before beginning this procedure.

1. Open the Java file to which you want to add the POJO service consumer.
2. If the Palette is not visible, click Window in the NetBeans toolbar and then click Palette.

   The Palette appears to the right of the Java Editor.

3. Drag and drop a POJO Consumer from the Palette to the location in the service provider in the Java file where you want to insert to POJO service consumer.

   The POJO SE Service Consumer Wizard appears.

   
   
4. Fill in the consumer properties, as described in POJO Service Consumer Properties.
5. Click Finish.

   The @ConsumerEndpoint annotation and related methods are added at the insertion point.

Next Steps

For instructions on creating a composite application for this project, see Creating a Composite Application for a POJO Service Consumer (Without Binding).

Creating a POJO Service Consumer (With Binding)

This procedure creates a POJO service consumer in an existing Java file using the Palette on the NetBeans Java Editor. Dragging and dropping a consumer into the Java code creates a framework for the service consumer, which you can then customize with the needed processing logic. When you add the consumer, you also configure the binding component for the service consumer and the WSDL file is automatically generated.

To Create a POJO Service Consumer (With Binding)

Before You Begin

The POJO service consumer can only be added within an existing provider. Make sure you have a provider defined in the Java class before beginning this procedure.

1. Open the Java file to which you want to add the POJO service consumer.
2. If the Palette is not visible, click Window in the NetBeans toolbar and then click Palette.

   The Palette appears to the right of the Java Editor.

3. Drag and drop a POJO Binding Consumer from the Palette to the location in the service provider in the Java file where you want to insert to POJO service consumer.

   The POJO SE Binding Service Consumer Wizard appears.

   
   
4. Fill in the name and location properties, as described in POJO Service Properties for Binding.

   ---

   Note - The sequence of steps changes to reflect the binding component and type you choose. The subsequent steps will vary depending on those two properties.

   ---

5. Click Next.

   The abstract binding configuration window appears.

6. Enter information about the binding component and type, and then click Next.

   ---

   Note - This page varies by binding component and type. For more information about a specific binding component, refer to the user's guide for that component or refer to the property descriptions at the bottom of the window. An example for the HTTP Binding Component is shown below.

   ---

   
   
7. If a second page of binding configuration appears, enter the required information and then click Next.
8. On the Name and Location window for the POJO service, the interface and operation fields are automatically populated. Fill in the fields described in Table 4 beginning with Invoke Pattern.
9. Click Finish.

   The @ConsumerEndpoint annotation and related methods are added at the insertion point.

Next Steps

For instructions on creating a composite application for this project, see Creating a Composite Application for a POJO Service Consumer (With Binding).

POJO Configuration Properties

When you create a POJO service consumer or provider, with or without binding, you need to configure certain properties so the POJO framework and optionally the WSDL documents can be generated correctly. The following topics describe the properties you need to configure. Note that these do not include specific binding component properties, which you need to configure if you are using bindings. For more information about these properties, see the user's guide for the specific binding component you are using.

• POJO Service Provider Properties

• POJO Service Properties for Binding

• POJO Service Consumer Properties

POJO Service Provider Properties

The following tables list and describe the properties you can configure when creating a new POJO service. These properties appear on the Name and Location page of the New POJO Service Wizard and on the Advanced Properties Editor, which is accessed from the Name and Location page.

Table 1 POJO Service Provider Name and Location Properties

Table 2 POJO Service Provider Advanced Properties

POJO Service Properties for Binding

The following table lists and describes the properties you can configure when creating a new POJO service provider or consumer with a binding component. These properties appear on the Name and Location page of the New POJO Service for Binding Wizard and the POJO SE Binding Service Consumer Wizard.

Table 3 Name and Location Properties for Binding

POJO Service Consumer Properties

The following table lists and describes the properties you can configure when creating a new POJO service consumer. These properties appear on the POJO SE Service Consumer Wizard.

Table 4 POJO Consumer Wizard Properties