public interface MediatorService
Carbon sequence editor
has to implement this interface and that implementation has to be registered as an
OSGi Service.
This provides the basic structure of a mediator for the sequence editor framework, and this also enables to add the mediators to the sequence editor user interface dynamically at runtime.
AbstractMediatorService
Modifier and Type | Method and Description |
---|---|
String |
getDisplayName()
This gives the display name for the mediator in the add mediator menu, and this can
be any
String . |
String |
getGroupName()
Gives the mediator categorization in the add mediator menu.
|
String |
getLogicalName()
This should be equivalent to
Mediator.getType() of the
mediator. |
Mediator |
getMediator()
Retrieves a default new mediator instances of the representing mediator.
|
String |
getTagLocalName()
This gives the mediator serialization tag local name.
|
String |
getUIFolderName() |
boolean |
isAddChildEnabled()
Whether this particular mediator can have children? Example of this usage is
filter org.apache.synapse.mediators.filters.FilterMediator
it cannot have children except for the then and else
mediators. |
boolean |
isAddSiblingEnabled()
Whether this particular mediator can have siblings? Example of this usage is
then child of the org.apache.synapse.mediators.filters.FilterMediator
cannot have mediator siblings. |
boolean |
isEditable()
If the mediator has editable configurations this method should return true.
|
boolean |
isMovingAllowed()
Is it possible to move this mediator in the sequence tree? Example of this usage is
default child of a org.apache.synapse.mediators.filters.SwitchMediator
it cannot be moved, there is no meaning of movement for the default |
boolean |
isSequenceRefreshRequired()
Some mediator updates require a refresh in the sequence editor.
|
String getTagLocalName()
org.apache.synapse.mediators.builtin.LogMediator
derived from the LogMediatorSerializer
the
tag local name is log
String getDisplayName()
String
. It is recommended to put a meaning full descriptive short name
as the display nameString getLogicalName()
Mediator.getType()
of the
mediator. The value of this is generally the class name without the package declaration.
Example: logical name of the org.apache.synapse.mediators.builtin.LogMediator
is LogMediator
String getGroupName()
Defined group names are:
String getUIFolderName()
boolean isAddSiblingEnabled()
then
child of the org.apache.synapse.mediators.filters.FilterMediator
cannot have mediator siblings.
This can also be used to enforce logical constraints like the
org.apache.synapse.mediators.builtin.DropMediator
, it is not logically effective
to have siblings after the drop
boolean isAddChildEnabled()
filter
org.apache.synapse.mediators.filters.FilterMediator
it cannot have children except for the then
and else
mediators.boolean isMovingAllowed()
default
child of a org.apache.synapse.mediators.filters.SwitchMediator
it cannot be moved, there is no meaning of movement for the default
boolean isEditable()
org.apache.synapse.mediators.filters.InMediator
cannot be updated.Mediator getMediator()
It is recommended to fill the required fields of the mediator with the default values if possible before returning the new instance, so that the user can just save this mediator if he/she is not smart.
boolean isSequenceRefreshRequired()
Copyright © 2020 WSO2. All rights reserved.