public abstract class AbstractTransportService extends Object implements TransportService
Modifier and Type | Field and Description |
---|---|
protected String |
transportName |
Constructor and Description |
---|
AbstractTransportService(String transportName) |
Modifier and Type | Method and Description |
---|---|
void |
addTransportParameter(TransportParameter param,
boolean listener,
org.apache.axis2.context.ConfigurationContext cfgCtx) |
abstract boolean |
dependenciesAvailable(TransportParameter[] params)
Whether the dependencies required by the transport are available
|
void |
disableTransport(boolean listener,
org.apache.axis2.engine.AxisConfiguration axisConfig)
Shutdown the transport
|
TransportParameter[] |
getGlobalTransportParameters(boolean listener,
org.apache.axis2.engine.AxisConfiguration axisConfig)
Get the set of globally defined transport parameters.
|
String |
getName()
Get the name of the transport protocol.
|
TransportParameter[] |
getServiceLevelTransportParameters(String service,
boolean listener,
org.apache.axis2.engine.AxisConfiguration axisConfig)
Get the set of service specific transport parameters.
|
boolean |
isAvailable(boolean listener,
org.apache.axis2.engine.AxisConfiguration axisConfig)
Check whether the transport is available for management activities
|
boolean |
isEnabled(boolean listener,
org.apache.axis2.engine.AxisConfiguration axisConfig)
Whether the transport is enabled
|
void |
removeTransportParameter(String param,
boolean listener,
org.apache.axis2.context.ConfigurationContext cfgCtx) |
void |
updateGlobalTransportParameters(TransportParameter[] params,
boolean listener,
org.apache.axis2.context.ConfigurationContext cfgCtx)
Update the global transport parameters
|
void |
updateServiceLevelTransportParameters(String service,
TransportParameter[] params,
boolean listener,
org.apache.axis2.context.ConfigurationContext cfgCtx)
Update the service level transport parameters
|
protected String transportName
public AbstractTransportService(String transportName)
public TransportParameter[] getGlobalTransportParameters(boolean listener, org.apache.axis2.engine.AxisConfiguration axisConfig) throws Exception
TransportService
getGlobalTransportParameters
in interface TransportService
listener
- Transport listener or senderaxisConfig
- AxisConfiguration of the tenantException
- On errorpublic String getName()
TransportService
getName
in interface TransportService
public TransportParameter[] getServiceLevelTransportParameters(String service, boolean listener, org.apache.axis2.engine.AxisConfiguration axisConfig) throws Exception
TransportService
getServiceLevelTransportParameters
in interface TransportService
service
- Name of the servicelistener
- Transport listener or senderaxisConfig
- AxisConfiguration of the tenantException
- On errorpublic boolean isAvailable(boolean listener, org.apache.axis2.engine.AxisConfiguration axisConfig)
TransportService
isAvailable
in interface TransportService
listener
- Transport listener or senderaxisConfig
- AxisConfiguration of the tenantpublic boolean isEnabled(boolean listener, org.apache.axis2.engine.AxisConfiguration axisConfig)
TransportService
isEnabled
in interface TransportService
listener
- Transport listener or senderaxisConfig
- AxisConfiguration of the tenantpublic void updateGlobalTransportParameters(TransportParameter[] params, boolean listener, org.apache.axis2.context.ConfigurationContext cfgCtx) throws Exception
TransportService
updateGlobalTransportParameters
in interface TransportService
params
- latest set of transport parameterslistener
- Transport listener or sendercfgCtx
- ConfigurationContext of the tenantException
- on errorpublic void updateServiceLevelTransportParameters(String service, TransportParameter[] params, boolean listener, org.apache.axis2.context.ConfigurationContext cfgCtx) throws Exception
TransportService
updateServiceLevelTransportParameters
in interface TransportService
service
- Name of the serviceparams
- latest set of transport parameterslistener
- transport listener or sendercfgCtx
- ConfigurationContext of the tenantException
- on errorpublic void disableTransport(boolean listener, org.apache.axis2.engine.AxisConfiguration axisConfig) throws Exception
TransportService
disableTransport
in interface TransportService
listener
- transport listener or senderaxisConfig
- AxisConfiguration of the tenantException
public void addTransportParameter(TransportParameter param, boolean listener, org.apache.axis2.context.ConfigurationContext cfgCtx) throws Exception
addTransportParameter
in interface TransportService
Exception
public void removeTransportParameter(String param, boolean listener, org.apache.axis2.context.ConfigurationContext cfgCtx) throws Exception
removeTransportParameter
in interface TransportService
Exception
public abstract boolean dependenciesAvailable(TransportParameter[] params)
TransportService
dependenciesAvailable
in interface TransportService
params
- An array of transport parametersCopyright © 2016 WSO2 Inc. All rights reserved.