ibrokerkit.iservicestore.store
Interface IService

All Superinterfaces:

java.lang.Comparable<IService>, java.io.Serializable

All Known Subinterfaces:

Authentication, Contact, Forwarding, Locator

All Known Implementing Classes:

AbstractAuthentication, AbstractContact, AbstractForwarding, AbstractLocator, DbAuthentication, DbContact, DbForwarding, DbLocator

public interface IService
extends java.io.Serializable, java.lang.Comparable<IService>

 An i-service is a service on a web page which is associated with one or more XRIs.
 
 The association between the i-service and XRIs is realized through the QXRI field. 
 This can be one of the following:
 
 1) An actual XRI, e.g. =myname. In this case, the i-service will only 
 be invoked when a request to exactly that XRI is made.
 
 2) An ID of an OpenXRI authority, e.g. 84. In this case, the i-service will
 be invoked when a request is made to any XRI that uses this authority. This is
 the preferred way of using ibrokerStore, since it properly supports XRI synonyms.
 
 For example, a single i-service can be associated with the following synonym XRIs, 
 assuming they all use the same OpenXRI authority:
 - =myname
 - =mysynonymname
 - =!91F2.8153.F600.AE24
 
 Another important concept is the INDX field. This value is not used internally by
 iserviceStore or iserviceFront, but can be used as a key for looking up i-services.
 In ibrokerKit, this value contains the identifier of a user in ibrokerStore and therefore
 associates i-services with users.
 

Method Summary

java.util.Map<java.lang.String,java.lang.String>	getAttributes() Get arbitrary key/value pairs.
java.lang.Boolean	getEnabled() Get a flag whether the i-service is enabled or not.
java.lang.Long	getId() Get the internal ID of this i-service.
java.lang.String	getIndx() Get the INDX value of this i-service.
java.lang.String	getName() Get the internal name of this i-service.
java.lang.String	getQxri() Get the QXRI this i-service is bound to.
java.util.Date	getTimestamp() Get the internal timestamp of this i-service.
void	setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes) Set arbitrary key/value pairs.
void	setEnabled(java.lang.Boolean enabled) Set a flag whether the i-service is enabled or not.
void	setIndx(java.lang.String indx) Set the INDX value of this i-service.
void	setName(java.lang.String name) Get the internal name of this i-service.
void	setQxri(java.lang.String qxri) Set the QXRI this i-service is bound to.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getId

java.lang.Long getId()

Get the internal ID of this i-service.

Returns:

ID.

getTimestamp

java.util.Date getTimestamp()

Get the internal timestamp of this i-service.

Returns:

Timestamp.

getQxri

java.lang.String getQxri()

Get the QXRI this i-service is bound to.

Returns:

Qxri.

setQxri

void setQxri(java.lang.String qxri)

Set the QXRI this i-service is bound to.

Parameters:

qxri - Qxri.

getName

java.lang.String getName()

Get the internal name of this i-service. This is only used for informational purposes and may be empty.

Returns:

Name.

setName

void setName(java.lang.String name)

Get the internal name of this i-service. This is only used for informational purposes and may be empty.

Parameters:

name - Name.

getEnabled

java.lang.Boolean getEnabled()

Get a flag whether the i-service is enabled or not. An i-service that is not enabled cannot be invoked through ibrokerFront.

Returns:

Enabled flag.

setEnabled

void setEnabled(java.lang.Boolean enabled)

Set a flag whether the i-service is enabled or not. An i-service that is not enabled cannot be invoked through ibrokerFront.

Parameters:

enabled - Enabled flag.

getAttributes

java.util.Map<java.lang.String,java.lang.String> getAttributes()

Get arbitrary key/value pairs. These attributes are not used internally.

Returns:

Attributes.

setAttributes

void setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)

Set arbitrary key/value pairs. These attributes are not used internally.

Parameters:

attributes - Attributes.

getIndx

java.lang.String getIndx()

Get the INDX value of this i-service.

Returns:

Indx.

setIndx

void setIndx(java.lang.String indx)

Set the INDX value of this i-service.

Parameters:

indx - Indx.