org.switchyard.metadata

Class ServiceMetadataBuilder

java.lang.Object

org.switchyard.metadata.ServiceMetadataBuilder

public final class ServiceMetadataBuilder
extends Object

Fluent builder for ServiceMetadata instances. This class can be used to create new ServiceMetadata objects or update existing instances of ServiceMetadata associated with a service or service reference.

Method Summary

Methods

Modifier and Type	Method and Description
ServiceMetadata	build() Returns a configured ServiceMetadata instance.
static ServiceMetadataBuilder	create() Creates a new ServiceMetadata instance.
static ServiceMetadataBuilder	createFrom(ServiceMetadata metadata) A copy operation which is compatible with the fluent builder API in case changes are necessary.
ServiceMetadataBuilder	providedPolicies(List<Policy> providedPolicies) Specifies provided policies for service metadata.
ServiceMetadataBuilder	registrant(Registrant registrant) Specifies the registrant of a service or service reference associated with this metadata.
ServiceMetadataBuilder	requiredPolicies(List<Policy> requiredPolicies) Specifies required policies for service metadata.
ServiceMetadataBuilder	security(ServiceSecurity security) Specifies service security for service metadata.
ServiceMetadataBuilder	throttling(Throttling throttling) Specifies throttling for service references.
static ServiceMetadataBuilder	update(ServiceMetadata metadata) Used to update an existing instance of ServiceMetadata by chaining additional calls after the call to update().

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

security

public ServiceMetadataBuilder security(ServiceSecurity security)

Specifies service security for service metadata.

Parameters:

security - service security

Returns:

this builder

requiredPolicies

public ServiceMetadataBuilder requiredPolicies(List<Policy> requiredPolicies)

Specifies required policies for service metadata.

Parameters:

requiredPolicies - required policies

Returns:

this builder

providedPolicies

public ServiceMetadataBuilder providedPolicies(List<Policy> providedPolicies)

Specifies provided policies for service metadata.

Parameters:

providedPolicies - provided policies

Returns:

this builder

registrant

public ServiceMetadataBuilder registrant(Registrant registrant)

Specifies the registrant of a service or service reference associated with this metadata.

Parameters:

registrant - the registrant of a service or reference

Returns:

this builder

throttling

public ServiceMetadataBuilder throttling(Throttling throttling)

Specifies throttling for service references. NOTE : this setting is ignored for services at present.

Parameters:

throttling - throttling setting

Returns:

this builder

build

public ServiceMetadata build()

Returns a configured ServiceMetadata instance.

Returns:

ServiceMetadata

create

public static ServiceMetadataBuilder create()

Creates a new ServiceMetadata instance. This method is called first when building a new ServiceMetadata instance.

Returns:

a reference to this builder to configure the ServiceMetadata

update

public static ServiceMetadataBuilder update(ServiceMetadata metadata)

Used to update an existing instance of ServiceMetadata by chaining additional calls after the call to update().

Parameters:

metadata - the ServiceMetadata to update

Returns:

a reference to this builder to configure the ServiceMetadata

createFrom

public static ServiceMetadataBuilder createFrom(ServiceMetadata metadata)

A copy operation which is compatible with the fluent builder API in case changes are necessary.

Parameters:

metadata - the ServiceMetadata to copy

Returns:

a reference to this builder to configure the ServiceMetadata