org.apache.synapse

Interface PropertyInclude

All Known Implementing Classes:

AbstractEndpoint, AddressEndpoint, DefaultEndpoint, DynamicLoadbalanceEndpoint, FailoverEndpoint, IndirectEndpoint, LoadbalanceEndpoint, RecipientListEndpoint, ResolvingEndpoint, SALoadbalanceEndpoint, ServiceDynamicLoadbalanceEndpoint, TemplateEndpoint, WSDLEndpoint

public interface PropertyInclude

This inteface makes an entity to have properties. Usually properties are specified in the XML configuration langugae.

Method Summary

Modifier and Type	Method and Description
void	addProperties(Collection<MediatorProperty> properties) Add a set of properties
void	addProperty(MediatorProperty property) Add a property
Collection<MediatorProperty>	getProperties() Get all the parameters as a Collection
MediatorProperty	getProperty(String name) Retrieve the property with the specific name
MediatorProperty	removeProperty(String name) Remove a property and return it

Method Detail

addProperty

void addProperty(MediatorProperty property)

Add a property

Parameters:

property - property to be added

addProperties

void addProperties(Collection<MediatorProperty> properties)

Add a set of properties

Parameters:

properties - Collection of properties to be added

getProperty

MediatorProperty getProperty(String name)

Retrieve the property with the specific name

Parameters:

name - name of the parameter

Returns:

the value of the parameter if present otherwise null

removeProperty

MediatorProperty removeProperty(String name)

Remove a property and return it

Parameters:

name - name of the property to be removed

Returns:

Property which is removed

getProperties

Collection<MediatorProperty> getProperties()

Get all the parameters as a Collection

Returns:

retrieve the parameters as a Collection