public abstract class AbstractContentDirectoryService extends Object
Only state variables and actions required by ContentDirectory:1 (not the optional ones) are implemented.
Modifier and Type | Field and Description |
---|---|
static String |
CAPS_WILDCARD |
protected PropertyChangeSupport |
propertyChangeSupport |
Modifier | Constructor and Description |
---|---|
protected |
AbstractContentDirectoryService() |
protected |
AbstractContentDirectoryService(List<String> searchCapabilities,
List<String> sortCapabilities) |
protected |
AbstractContentDirectoryService(List<String> searchCapabilities,
List<String> sortCapabilities,
PropertyChangeSupport propertyChangeSupport) |
Modifier and Type | Method and Description |
---|---|
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,
org.fourthline.cling.model.types.UnsignedIntegerFourBytes firstResult,
org.fourthline.cling.model.types.UnsignedIntegerFourBytes maxResults,
String orderBy) |
protected void |
changeSystemUpdateID()
Call this method after making changes to your content directory.
|
PropertyChangeSupport |
getPropertyChangeSupport() |
org.fourthline.cling.model.types.csv.CSV<String> |
getSearchCapabilities() |
org.fourthline.cling.model.types.csv.CSV<String> |
getSortCapabilities() |
org.fourthline.cling.model.types.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,
org.fourthline.cling.model.types.UnsignedIntegerFourBytes firstResult,
org.fourthline.cling.model.types.UnsignedIntegerFourBytes maxResults,
String orderBy) |
public static final String CAPS_WILDCARD
protected final PropertyChangeSupport propertyChangeSupport
protected AbstractContentDirectoryService()
protected AbstractContentDirectoryService(List<String> searchCapabilities, List<String> sortCapabilities)
protected AbstractContentDirectoryService(List<String> searchCapabilities, List<String> sortCapabilities, PropertyChangeSupport propertyChangeSupport)
public org.fourthline.cling.model.types.csv.CSV<String> getSearchCapabilities()
public org.fourthline.cling.model.types.csv.CSV<String> getSortCapabilities()
public org.fourthline.cling.model.types.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, org.fourthline.cling.model.types.UnsignedIntegerFourBytes firstResult, org.fourthline.cling.model.types.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, org.fourthline.cling.model.types.UnsignedIntegerFourBytes firstResult, org.fourthline.cling.model.types.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
Copyright © 2016 4th Line GmbH, Switzerland. All rights reserved.