Defining an Inlet

How to:

Each inlet contains a sequence of listeners, optional decryptors, and optional preparsers.

Listeners are defined as protocol handlers and are responsible for startup, shutdown, and obtaining the incoming messages. Listeners receive the messages from the transport protocol, set special registers such as header values and input source, and then pass the message to a decryptor.

Decryptors can apply a decryption algorithm to the incoming message and verify the security of the message. A decryptor can be used to verify that the sender is authorized, to check that the message has not been changed, and to decrypt any part of the message that has been encrypted. Finally, the decryptor passes the message to a preparser.

Preparsers convert transported messages into processable documents. For example, some preparsers convert non-XML messages into XML documents. Preparsers can be chained, so that the output of one preparser becomes the input of the next preparser. Input to the first preparser is a byte stream, and output is a properly encoded string. Subsequent preparsers accept and emit strings.
Top of page
x
Procedure: How to Define an Inlet

To define an inlet using the iWay Service Manager Administration Console:

  1. In the left console pane of the Registry menu, select Inlets.

    The Inlets pane opens.

    The table that is provided lists each inlet that is defined with a brief description. If you click the document schematic icon in the References column for a specific inlet, you will see which components are referencing that inlet.

    The following image shows the result of clicking the schematic icon for the file1 inlet:

  2. Click Add.

    The New Inlet Definition pane opens.

  3. Enter a name, for example, SampleInlet, and description for the inlet.
  4. Click Finish.

    The Construct Inlet pane opens.

    The table that is provided is used to list the components that are currently registered with the inlet.

  5. Click Add.

    The Select component type pane opens.

    The table that is provided lists the component types you can select and register with the inlet you are defining.

    • Listener - Protocol handlers that receive input for a channel from a configured endpoint.
    • Decryptor - Used to decrypt a document.
    • Preparser - A logical process that handles documents before they are parsed by the system, for example, converting a non-XML document to XML.

    Note: Each inlet is required to have a registered listener. The remaining components are optional during inlet configuration. For more information on creating a listener, see Configuring iWay Registry Components.

  6. Select Listener from the list of component types and click Next.

    The Select a listener definition pane opens, as shown in the following image.

  7. Select a defined listener, for example, file1, from the list and click Finish.

    You are returned to the Construct Inlet pane, which now includes the listener (file1) you registered with your inlet (SampleInlet).

    You can repeat this process to define additional components for the inlet, such as a decryptor or a preparser.

    If you return to the main Inlets pane, you will notice that the inlet you just defined (SampleInlet) has been added to the list, as shown in the following image.
Top of page
x
Procedure: How to Modify an Inlet

You can modify an inlet by changing one of the components already defined for the inlet or by adding new components.

Note: If you change one of the components assigned to an inlet, such as a listener, the component will be changed in the registry, not only in the particular inlet you are modifying.

To modify an inlet:

  1. Click the name of the inlet you wish to modify in the main Inlets pane, for example, SampleInlet.

    The Construct Inlet pane opens.

    The table that is provided shows the component that has been registered for the inlet you are modifying. In this example, the file1 listener is used.

  2. Modify the inlet as required:
    • To replace one of the components, such as a listener, remove the name of the listener.
    • To add a new component, select the component type, and click Next.

      For more information on listeners, decryptors, and preparsers, see Configuring iWay Registry Components.

  3. Make your changes to the listener properties as required and click Update when you are finished, or select the component you are adding and click Finish.

    The inlet is now modified.

Top of page
x
Procedure: How to Delete an Inlet

To delete an inlet:

  1. Click the check box next to the inlet you wish to delete, for example, SampleInlet.
  2. Click Delete.

    A confirmation dialog box opens, prompting you to confirm the deletion of the inlet.

  3. Click OK.

    The inlet is deleted from the system.

    Tip: To delete more than one inlet at once, you can select multiple check boxes in the Inlets pane and click Delete.
Top of page
x
Procedure: How to Rename an Inlet

To rename an inlet:

  1. Click the check box next to the inlet you wish to rename, for example, SampleInlet.
  2. Click Rename.

    The Rename pane opens.

  3. Type a name, for example, TestInlet, in the New Name field and click Finish.

    You are returned to the main Inlets pane.

    The new name for the inlet you provided is shown.
Top of page
x
Procedure: How to Copy an Inlet

To copy an inlet:

  1. Click the check box next to the inlet you wish to copy, for example, SampleInlet.
  2. Click Copy.

    A copy of the inlet is made, as shown in the following image.

    Making copies of an inlet is useful for versioning and testing purposes.

    Tip: To copy more than one inlet at once, you can select multiple check boxes in the Inlets pane and click Copy.

iWay Software