Package org.jupnp.support.contentdirectory

Klasse AbstractContentDirectoryService

java.lang.Object

org.jupnp.support.contentdirectory.AbstractContentDirectoryService

public abstract class AbstractContentDirectoryService
extends Object

Simple ContentDirectory service skeleton.

Only state variables and actions required by ContentDirectory:1 (not the optional ones) are implemented.

Autor:

Alessio Gaeta, Christian Bauer, Amit Kumar Mondal - Code Refactoring

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
static final String	CAPS_WILDCARD
protected final PropertyChangeSupport	propertyChangeSupport

Konstruktorübersicht

Konstruktoren

Modifizierer	Konstruktor	Beschreibung
protected	AbstractContentDirectoryService()
protected	AbstractContentDirectoryService(List<String> searchCapabilities, List<String> sortCapabilities)
protected	AbstractContentDirectoryService(List<String> searchCapabilities, List<String> sortCapabilities, PropertyChangeSupport propertyChangeSupport)

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
BrowseResult	browse(String objectId, String browseFlag, String filter, UnsignedIntegerFourBytes firstResult, UnsignedIntegerFourBytes maxResults, String orderBy)
abstract BrowseResult	browse(String objectID, BrowseFlag browseFlag, String filter, long firstResult, long maxResults, SortCriterion[] orderby)	Implement this method to implement browsing of your content.
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)

Von Klasse geerbte Methoden java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Felddetails

CAPS_WILDCARD

public static final String CAPS_WILDCARD

Siehe auch:

• Konstantenfeldwerte

propertyChangeSupport

protected final PropertyChangeSupport propertyChangeSupport

Konstruktordetails

AbstractContentDirectoryService

protected AbstractContentDirectoryService()

AbstractContentDirectoryService

protected AbstractContentDirectoryService(List<String> searchCapabilities,
 List<String> sortCapabilities)

AbstractContentDirectoryService

protected AbstractContentDirectoryService(List<String> searchCapabilities,
 List<String> sortCapabilities,
 PropertyChangeSupport propertyChangeSupport)

Methodendetails

getSearchCapabilities

public CSV<String> getSearchCapabilities()

getSortCapabilities

public CSV<String> getSortCapabilities()

getSystemUpdateID

public UnsignedIntegerFourBytes getSystemUpdateID()

getPropertyChangeSupport

public PropertyChangeSupport getPropertyChangeSupport()

changeSystemUpdateID

protected void changeSystemUpdateID()

Call this method after making changes to your content directory.

This will notify clients that their view of the content directory is potentially outdated and has to be refreshed.

browse

public BrowseResult browse(String objectId,
 String browseFlag,
 String filter,
 UnsignedIntegerFourBytes firstResult,
 UnsignedIntegerFourBytes maxResults,
 String orderBy)
                    throws ContentDirectoryException

Löst aus:

ContentDirectoryException

browse

public abstract BrowseResult browse(String objectID,
 BrowseFlag browseFlag,
 String filter,
 long firstResult,
 long maxResults,
 SortCriterion[] orderby)
                             throws ContentDirectoryException

Implement this method to implement browsing of your content.

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.

Löst aus:

ContentDirectoryException

search

public BrowseResult search(String containerId,
 String searchCriteria,
 String filter,
 UnsignedIntegerFourBytes firstResult,
 UnsignedIntegerFourBytes maxResults,
 String orderBy)
                    throws ContentDirectoryException

Löst aus:

ContentDirectoryException

search

public BrowseResult search(String containerId,
 String searchCriteria,
 String filter,
 long firstResult,
 long maxResults,
 SortCriterion[] orderBy)
                    throws ContentDirectoryException

Override this method to implement searching of your content.

The default implementation returns an empty result.

Löst aus:

ContentDirectoryException