org.apache.wsrp4j.producer
Interface ConsumerRegistry


public interface ConsumerRegistry

This interface provides access to the ConsumerRegistry. The ConsumerRegistry keeps all Consumer registrations with this Producer. All registrations are identified by a registration handle.

Author:
Stefan Behl

Method Summary
 boolean check(java.lang.String regHandle)
          Evaluates whether a consumer identified by regHandle is registered or not.
 void deregister(java.lang.String regHandle)
          Deletes the registration of a certain consumer (identified by regHandle).
 Registration get(java.lang.String regHandle)
          Returns a certain registration identified by regHandle.
 java.util.Iterator getAll()
          Returns all registrations (of all consumers) currently stored in the consumer registry.
 boolean isRegistrationRequired()
          Provides information about whether this producer requires registration or not.
 Registration register(RegistrationData registrationData)
          Creates a new registration-object for a certain consumer, adds it to the consumer registry and returns it.
 

Method Detail

isRegistrationRequired

public boolean isRegistrationRequired()
Provides information about whether this producer requires registration or not.

Returns:
A boolean indicating whether registration is required or not.

register

public Registration register(RegistrationData registrationData)
                      throws WSRPException
Creates a new registration-object for a certain consumer, adds it to the consumer registry and returns it.

Parameters:
registrationData - RegistrationData-object
Returns:
new registration-object
Throws:
WSRPException

get

public Registration get(java.lang.String regHandle)
Returns a certain registration identified by regHandle.

Parameters:
regHandle - String representing the regHandle.
Returns:
registration-object identified by regHandle.

getAll

public java.util.Iterator getAll()
Returns all registrations (of all consumers) currently stored in the consumer registry.

Returns:
Iterator of a registration collection containing all registrations.

deregister

public void deregister(java.lang.String regHandle)
Deletes the registration of a certain consumer (identified by regHandle).

Parameters:
regHandle - String representing the regHandle.

check

public boolean check(java.lang.String regHandle)
Evaluates whether a consumer identified by regHandle is registered or not.

Parameters:
regHandle - String representing the regHandle.