Package tigase.server.extdisco
Class ExtServiceDiscoItem
java.lang.Object
tigase.db.comp.RepositoryItemAbstract
tigase.server.extdisco.ExtServiceDiscoItem
- All Implemented Interfaces:
RepositoryItem
Created by andrzej on 06.09.2016.
-
Field Summary
Fields inherited from class tigase.db.comp.RepositoryItemAbstract
ADMINS_ATT, ADMINS_LABEL, OWNER_ATT, OWNER_LABEL
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addCommandFields
(Packet packet) The method is used for handling ad-hoc commands.String[]
Returns an array with the Item administrators, that is people IDs who can manage, configure and control less critical elements of the Item, like changing less critical configuration settings.getKey()
Returns a unique key for the item in the repository.getOwner()
Returns the owner ID of the item.getType()
void
initFromCommand
(Packet packet) The method used for handling ad-hoc commands.void
initFromElement
(Element elem) The item can be also initialized from a more complex repositories: XML repository or SQL database.void
initFromPropertyString
(String propString) The item can be initialized based on the data loaded from a configuration file.boolean
The method checks whether the given id is one of the administrators set for the Item.boolean
The method checks whether the person with given ID is the Item owner.void
Returns an array with the Item administrators, that is people IDs who can manage, configure and control less critical elements of the Item, like changing less critical configuration settings.protected void
void
Set the Item owner.Item data can be stored in a more complex form than a simple property string.The item can be initialized based on the data loaded from a configuration file.
-
Constructor Details
-
ExtServiceDiscoItem
public ExtServiceDiscoItem()
-
-
Method Details
-
addCommandFields
Description copied from interface:RepositoryItem
The method is used for handling ad-hoc commands. The 'empty' ad-hoc command packet is provided and the Item should fill it with fields for the user.- Specified by:
addCommandFields
in interfaceRepositoryItem
- Overrides:
addCommandFields
in classRepositoryItemAbstract
- Parameters:
packet
- with empty ad-hoc command to fill with fields
-
getAdmins
Description copied from interface:RepositoryItem
Returns an array with the Item administrators, that is people IDs who can manage, configure and control less critical elements of the Item, like changing less critical configuration settings. Administrators cannot remove the Item or change the owner or add/remove administrators.- Specified by:
getAdmins
in interfaceRepositoryItem
- Overrides:
getAdmins
in classRepositoryItemAbstract
- Returns:
- an array with the Item administrators IDs.
-
setAdmins
Description copied from interface:RepositoryItem
Returns an array with the Item administrators, that is people IDs who can manage, configure and control less critical elements of the Item, like changing less critical configuration settings. Administrators cannot remove the Item or change the owner or add/remove administrators.- Specified by:
setAdmins
in interfaceRepositoryItem
- Overrides:
setAdmins
in classRepositoryItemAbstract
- Parameters:
admins
- is an array with the Item administrators IDs to set for the Item.
-
getElemName
- Specified by:
getElemName
in classRepositoryItemAbstract
-
getKey
Description copied from interface:RepositoryItem
Returns a unique key for the item in the repository. All items are stored in a memory cache which is a Map. And the key returned by this method is the item identifier in the Map.- Returns:
- an Item key.
-
setKey
- Specified by:
setKey
in classRepositoryItemAbstract
-
getOwner
Description copied from interface:RepositoryItem
Returns the owner ID of the item. This is used for a management to allow fine tuned service administration with roles assigned to specific elements and items. Normally only owner can perform some critical actions like removing the item, managing item administrators or changing owner.
There can be only one Item owner.- Specified by:
getOwner
in interfaceRepositoryItem
- Overrides:
getOwner
in classRepositoryItemAbstract
- Returns:
- an ID of the Item owner.
-
setOwner
Description copied from interface:RepositoryItem
Set the Item owner. This is used for a management to allow fine tuned service administration with roles assigned to specific elements and items. Normally only owner can perform some critical actions like removing the item, managing item administrators or changing owner.
There can be only one Item owner.- Specified by:
setOwner
in interfaceRepositoryItem
- Overrides:
setOwner
in classRepositoryItemAbstract
- Parameters:
owner
- is the Item owner ID.
-
getType
-
initFromCommand
Description copied from interface:RepositoryItem
The method used for handling ad-hoc commands. After a user fills all given field the ad-hoc command packet is passed back to the item to initialize it with data. Similar method to initFromElement(), but the data source is different.- Specified by:
initFromCommand
in interfaceRepositoryItem
- Overrides:
initFromCommand
in classRepositoryItemAbstract
- Parameters:
packet
- with ad-hoc command filled by the user.
-
initFromElement
Description copied from interface:RepositoryItem
The item can be also initialized from a more complex repositories: XML repository or SQL database. In such a case more complex representation is prefered, possibly carrying more information about the item. The method is called to initialize the item with a data parsed from an XML representation of the repository.- Specified by:
initFromElement
in interfaceRepositoryItem
- Overrides:
initFromElement
in classRepositoryItemAbstract
- Parameters:
elem
- XML Element with all the item initialization data.
-
initFromPropertyString
Description copied from interface:RepositoryItem
The item can be initialized based on the data loaded from a configuration file. In such a case the item representation is usually very simplified as a list of parameters separated by a marker. Please note, usually each item is separated from another with a comma, therefore do not use a comma in the item property string. Double collon is commonly used alternative.- Parameters:
propString
- is a property string to initialize the RepositoryItem.
-
isAdmin
Description copied from interface:RepositoryItem
The method checks whether the given id is one of the administrators set for the Item.- Specified by:
isAdmin
in interfaceRepositoryItem
- Overrides:
isAdmin
in classRepositoryItemAbstract
- Parameters:
id
- is an ID of a person for which we check access permissions.- Returns:
- true of the given ID is on a list of administrators and false otherwise.
-
isOwner
Description copied from interface:RepositoryItem
The method checks whether the person with given ID is the Item owner.- Specified by:
isOwner
in interfaceRepositoryItem
- Overrides:
isOwner
in classRepositoryItemAbstract
- Parameters:
id
- is an ID of a person for whom we check access permissions.- Returns:
- true of the given ID is on the Item owner and false otherwise.
-
toElement
Description copied from interface:RepositoryItem
Item data can be stored in a more complex form than a simple property string. The XML Element can contain much more detailed information about the element than the simplified form and is used to store the repository item in more advanced repositories then just property file. XML repository or SQL database can keep many records for repository item with as much detailed information as needed.- Specified by:
toElement
in interfaceRepositoryItem
- Overrides:
toElement
in classRepositoryItemAbstract
- Returns:
- an XML Element with all the item initialization data.
-
toPropertyString
Description copied from interface:RepositoryItem
The item can be initialized based on the data loaded from a configuration file. In such a case the item representation is usually very simplified as a list of parameters separated by a marker. Please note, usually each item is separated from another with a comma, therefore do not use a comma in the item property string. Double collon is commonly used alternative.- Returns:
- a property string representing the repository item in a simplified form.
-