org.teleal.cling.support.contentdirectory.callback
Class Browse

java.lang.Object
  extended by org.teleal.cling.controlpoint.ActionCallback
      extended by org.teleal.cling.support.contentdirectory.callback.Browse
All Implemented Interfaces:
Runnable
Direct Known Subclasses:
ContentBrowseActionCallback

public abstract class Browse
extends org.teleal.cling.controlpoint.ActionCallback

Invokes a "Browse" action, parses the result.

Author:
Christian Bauer

Nested Class Summary
static class Browse.Status
           
 
Nested classes/interfaces inherited from class org.teleal.cling.controlpoint.ActionCallback
org.teleal.cling.controlpoint.ActionCallback.Default
 
Field Summary
static String CAPS_WILDCARD
           
 
Fields inherited from class org.teleal.cling.controlpoint.ActionCallback
actionInvocation, controlPoint
 
Constructor Summary
Browse(org.teleal.cling.model.meta.Service service, String containerId, BrowseFlag flag)
          Browse with first result 0 and getDefaultMaxResults(), filters with CAPS_WILDCARD.
Browse(org.teleal.cling.model.meta.Service service, String objectID, BrowseFlag flag, String filter, long firstResult, Long maxResults, SortCriterion... orderBy)
           
 
Method Summary
 long getDefaultMaxResults()
          Some media servers will crash if there is no limit on the maximum number of results.
abstract  void received(org.teleal.cling.model.action.ActionInvocation actionInvocation, DIDLContent didl)
           
 boolean receivedRaw(org.teleal.cling.model.action.ActionInvocation actionInvocation, BrowseResult browseResult)
           
 void run()
           
 void success(org.teleal.cling.model.action.ActionInvocation invocation)
           
abstract  void updateStatus(Browse.Status status)
           
 
Methods inherited from class org.teleal.cling.controlpoint.ActionCallback
createDefaultFailureMessage, failure, failure, getActionInvocation, getControlPoint, setControlPoint, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CAPS_WILDCARD

public static final String CAPS_WILDCARD
See Also:
Constant Field Values
Constructor Detail

Browse

public Browse(org.teleal.cling.model.meta.Service service,
              String containerId,
              BrowseFlag flag)
Browse with first result 0 and getDefaultMaxResults(), filters with CAPS_WILDCARD.


Browse

public Browse(org.teleal.cling.model.meta.Service service,
              String objectID,
              BrowseFlag flag,
              String filter,
              long firstResult,
              Long maxResults,
              SortCriterion... orderBy)
Parameters:
maxResults - Can be null, then getDefaultMaxResults() is used.
Method Detail

run

public void run()
Specified by:
run in interface Runnable
Overrides:
run in class org.teleal.cling.controlpoint.ActionCallback

success

public void success(org.teleal.cling.model.action.ActionInvocation invocation)
Specified by:
success in class org.teleal.cling.controlpoint.ActionCallback

getDefaultMaxResults

public long getDefaultMaxResults()
Some media servers will crash if there is no limit on the maximum number of results.

Returns:
The default limit, 999.

receivedRaw

public boolean receivedRaw(org.teleal.cling.model.action.ActionInvocation actionInvocation,
                           BrowseResult browseResult)

received

public abstract void received(org.teleal.cling.model.action.ActionInvocation actionInvocation,
                              DIDLContent didl)

updateStatus

public abstract void updateStatus(Browse.Status status)


Copyright © 2010 Teleal GmbH, Switzerland. All Rights Reserved.