The Diffusion Publisher API is deprecated and will be removed in a future release.
@Deprecated public interface PublisherConfig extends Config
Most values may not be changed once the server has been started.
Modifier and Type | Method and Description |
---|---|
PropertyConfig |
addProperty(String name,
String value)
Deprecated.
Add a publisher property.
|
PropertyConfig |
addProperty(String name,
String type,
String value)
Deprecated.
Add a publisher property.
|
SubscriptionValidationPolicyConfig |
addSubscriptionValidationPolicy(String name)
Deprecated.
Add a new subscription validation policy for the publisher.
|
String |
getClassName()
Deprecated.
Gets the publisher class name.
|
LogDescription.LogLevel |
getLogLevel()
Deprecated.
Gets the log level for this publisher.
|
String |
getName()
Deprecated.
Returns the Publisher name.
|
List<PropertyConfig> |
getProperties()
Deprecated.
Gets list of Publisher properties.
|
PropertyConfig |
getProperty(String name)
Deprecated.
Get a named property.
|
String |
getPropertyValue(String name)
Deprecated.
Gets the value of a named property as a String.
|
List<SubscriptionValidationPolicyConfig> |
getSubscriptionValidationPolicies()
Deprecated.
Get the subscription validation policies defined for the publisher.
|
SubscriptionValidationPolicyConfig |
getSubscriptionValidationPolicy(String name)
Deprecated.
Get a named subscription validation policy that belongs to the publisher.
|
boolean |
isAutoStart()
Deprecated.
Is auto start set?
|
boolean |
isEnabled()
Deprecated.
Is the Publisher enabled?
|
boolean |
isStopServerIfNotLoaded()
Deprecated.
Indicates whether to stop server if publisher does not load.
|
SubscriptionValidationPolicyConfig |
removeSubscriptionValidationPolicy(String name)
Deprecated.
Remove a subscription validation policy.
|
void |
setAutoStart(boolean autoStart)
Deprecated.
Sets the publisher start property.
|
void |
setEnabled(boolean enabled)
Deprecated.
Sets the publisher enabled property.
|
void |
setLogLevel(LogDescription.LogLevel level)
Deprecated.
Sets the log level for the publisher.
|
void |
setStopServerIfNotLoaded(boolean stopIfNotLoaded)
Deprecated.
Sets whether to stop the server if publisher does not load.
|
String getName()
String getClassName()
void setEnabled(boolean enabled) throws ConfigException
By setting enabled to false, the publisher will not be loaded.
By default this is true.
enabled
- true to enable, false to disableConfigException
- if unable to set propertyboolean isEnabled()
void setAutoStart(boolean autoStart) throws ConfigException
Specifies whether the Publisher should automatically start when the Diffusion Server starts.
By default this is true.
autoStart
- true to automatically startConfigException
- if unable to set propertyboolean isAutoStart()
void setStopServerIfNotLoaded(boolean stopIfNotLoaded) throws ConfigException
If set and the publisher fails to load, the Diffusion Server will be stopped.
By default this is set to false.
stopIfNotLoaded
- true if the server is to stop if publisher does
not load.ConfigException
- if unable to set propertyboolean isStopServerIfNotLoaded()
void setLogLevel(LogDescription.LogLevel level) throws ConfigException
If not specified, the log level will be the default.
level
- the log levelConfigException
- if unable to set propertyLogDescription.LogLevel getLogLevel()
List<PropertyConfig> getProperties()
PropertyConfig getProperty(String name)
name
- property nameString getPropertyValue(String name)
name
- the property namePropertyConfig addProperty(String name, String value) throws ConfigException
name
- the property namevalue
- the property valueConfigException
- if unable to add propertyPropertyConfig addProperty(String name, String type, String value) throws ConfigException
name
- the property nametype
- the property typevalue
- the property valueConfigException
- if unable to add propertyList<SubscriptionValidationPolicyConfig> getSubscriptionValidationPolicies()
SubscriptionValidationPolicyConfig getSubscriptionValidationPolicy(String name)
name
- the policy nameSubscriptionValidationPolicyConfig addSubscriptionValidationPolicy(String name) throws ConfigException
A new policy may be added even if the server has started.
name
- the policy nameConfigException
- if unable to add policy with given nameSubscriptionValidationPolicyConfig removeSubscriptionValidationPolicy(String name)
name
- the policy nameCopyright © 2020 Push Technology Ltd. All Rights Reserved.