|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.fourthline.cling.support.contentdirectory.AbstractContentDirectoryService
public abstract class AbstractContentDirectoryService
Simple ContentDirectory service skeleton.
Only state variables and actions required by ContentDirectory:1 (not the optional ones) are implemented.
Field Summary | |
---|---|
static String |
CAPS_WILDCARD
|
protected PropertyChangeSupport |
propertyChangeSupport
|
Constructor Summary | |
---|---|
protected |
AbstractContentDirectoryService()
|
protected |
AbstractContentDirectoryService(List<String> searchCapabilities,
List<String> sortCapabilities)
|
protected |
AbstractContentDirectoryService(List<String> searchCapabilities,
List<String> sortCapabilities,
PropertyChangeSupport propertyChangeSupport)
|
Method Summary | |
---|---|
abstract BrowseResult |
browse(String objectID,
BrowseFlag browseFlag,
String filter,
long firstResult,
long maxResults,
SortCriterion[] orderby)
Implement this method to implement browsing of your content. |
BrowseResult |
browse(String objectId,
String browseFlag,
String filter,
UnsignedIntegerFourBytes firstResult,
UnsignedIntegerFourBytes maxResults,
String orderBy)
|
protected void |
changeSystemUpdateID()
Call this method after making changes to your content directory. |
PropertyChangeSupport |
getPropertyChangeSupport()
|
CSV<String> |
getSearchCapabilities()
|
CSV<String> |
getSortCapabilities()
|
UnsignedIntegerFourBytes |
getSystemUpdateID()
|
BrowseResult |
search(String containerId,
String searchCriteria,
String filter,
long firstResult,
long maxResults,
SortCriterion[] orderBy)
Override this method to implement searching of your content. |
BrowseResult |
search(String containerId,
String searchCriteria,
String filter,
UnsignedIntegerFourBytes firstResult,
UnsignedIntegerFourBytes maxResults,
String orderBy)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String CAPS_WILDCARD
protected final PropertyChangeSupport propertyChangeSupport
Constructor Detail |
---|
protected AbstractContentDirectoryService()
protected AbstractContentDirectoryService(List<String> searchCapabilities, List<String> sortCapabilities)
protected AbstractContentDirectoryService(List<String> searchCapabilities, List<String> sortCapabilities, PropertyChangeSupport propertyChangeSupport)
Method Detail |
---|
public CSV<String> getSearchCapabilities()
public CSV<String> getSortCapabilities()
public UnsignedIntegerFourBytes getSystemUpdateID()
public PropertyChangeSupport getPropertyChangeSupport()
protected void changeSystemUpdateID()
This will notify clients that their view of the content directory is potentially outdated and has to be refreshed.
public BrowseResult browse(String objectId, String browseFlag, String filter, UnsignedIntegerFourBytes firstResult, UnsignedIntegerFourBytes maxResults, String orderBy) throws ContentDirectoryException
ContentDirectoryException
public abstract BrowseResult browse(String objectID, BrowseFlag browseFlag, String filter, long firstResult, long maxResults, SortCriterion[] orderby) throws ContentDirectoryException
This is a required action defined by ContentDirectory:1.
You should wrap any exception into a ContentDirectoryException
, so a propery
error message can be returned to control points.
ContentDirectoryException
public BrowseResult search(String containerId, String searchCriteria, String filter, UnsignedIntegerFourBytes firstResult, UnsignedIntegerFourBytes maxResults, String orderBy) throws ContentDirectoryException
ContentDirectoryException
public BrowseResult search(String containerId, String searchCriteria, String filter, long firstResult, long maxResults, SortCriterion[] orderBy) throws ContentDirectoryException
The default implementation returns an empty result.
ContentDirectoryException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |