JSR-043: JTAPI-1.4

javax.telephony.media.container.async
Interface Async_ContainerService

All Superinterfaces:
CoderConstants, ContainerConstants, ContainerService
All Known Implementing Classes:
Base_ContainerService

public interface Async_ContainerService
extends ContainerService

Non-blocking methods for manipulating Containers.

Since:
JTAPI-1.4

Fields inherited from interface javax.telephony.media.container.ContainerConstants
b_Append, b_Create, b_Exclusive, b_Truncate, e_OK, k_InputParameters, k_MediaType, k_MediaTypes, v_AccessCopy, v_AccessRead, v_AccessWrite, v_Begin, v_Bytes, v_Create, v_Current, v_End, v_Fail, v_MDO, v_MilliSeconds
 
Fields inherited from interface javax.telephony.media.CoderConstants
v_24kADPCM, v_32kADPCM, v_44kADPCM, v_48k8BitLinear, v_48kALawPCM, v_48kMuLawPCM, v_64k8BitLinear, v_64kALawPCM, v_64kMuLawPCM, v_88k8BitLinear, v_88kALawPCM, v_88kMuLawPCM, v_ADPCM_24k, v_ADPCM_32k, v_ADPCM_44k, v_ADSI, v_ALawPCM_48k, v_ALawPCM_64k, v_ALawPCM_88k, v_ASCII, v_Linear8Bit_48k, v_Linear8Bit_64k, v_Linear8Bit_88k, v_MuLawPCM_48k, v_MuLawPCM_64k, v_MuLawPCM_88k, v_TDD
 
Method Summary
 void addListener(java.util.EventListener listener)
          Add listener for Container event completions.
 Async_ContainerEvent async_changeMode(java.lang.String fullName, Symbol accessMode, java.util.Dictionary optargs)
          change the access rights of a container.
 Async_ContainerEvent async_copy(java.lang.String fullName, java.lang.String target, java.util.Dictionary optargs)
          Copy one DataObject to new DataObject name.
 Async_ContainerEvent async_createContainer(java.lang.String fullName, java.util.Dictionary optargs)
          Create a new Container.
 Async_ContainerEvent async_createDataObject(java.lang.String fullName, Symbol accessMode, java.util.Dictionary optargs)
          Create a new Data Object and open it.
 Async_ContainerEvent async_destroy(java.lang.String fullName, java.util.Dictionary optargs)
          remove this container and all data objects.
 Async_ContainerEvent async_getInfo(java.lang.String fullName, Symbol[] keys, java.util.Dictionary optargs)
          Return arbitrary user infomation stored with a Container or DataObject.
 Async_ContainerEvent async_getParameters(java.lang.String fullName, Symbol[] keys, java.util.Dictionary optargs)
          get system parameters on a Container or DataObject.
 Async_ContainerEvent async_listObjects(java.lang.String fullName, java.util.Dictionary optargs)
          list inner objects and containers.
 Async_ContainerEvent async_openDataObject(java.lang.String fullName, Symbol accessMode, boolean ifNoExist, boolean truncate, java.util.Dictionary optargs)
          Open a Data Object.
 Async_ContainerEvent async_rename(java.lang.String fullName, java.lang.String newName, java.util.Dictionary optargs)
          Rename a Container or DataObject within its current Container.
 Async_ContainerEvent async_setInfo(java.lang.String fullName, java.util.Dictionary dict)
          Store arbitrary user infomation with a Container or DataObject.
 Async_ContainerEvent async_setParameters(java.lang.String fullName, java.util.Dictionary params)
          set system parameters on a Container or DataObject.
 void removeListener(java.util.EventListener listener)
          Remove listener for Container event completions.
 
Methods inherited from interface javax.telephony.media.container.ContainerService
changeMode, copy, createContainer, createDataObject, destroy, getInfo, getParameters, listObjects, openDataObject, rename, setInfo, setParameters
 

Method Detail

async_setInfo

public Async_ContainerEvent async_setInfo(java.lang.String fullName,
                                          java.util.Dictionary dict)
Store arbitrary user infomation with a Container or DataObject.
See Also:
setInfo

async_getInfo

public Async_ContainerEvent async_getInfo(java.lang.String fullName,
                                          Symbol[] keys,
                                          java.util.Dictionary optargs)
Return arbitrary user infomation stored with a Container or DataObject.
See Also:
getInfo

async_setParameters

public Async_ContainerEvent async_setParameters(java.lang.String fullName,
                                                java.util.Dictionary params)
set system parameters on a Container or DataObject.
See Also:
setParameters

async_getParameters

public Async_ContainerEvent async_getParameters(java.lang.String fullName,
                                                Symbol[] keys,
                                                java.util.Dictionary optargs)
get system parameters on a Container or DataObject.
See Also:
getParameters

async_changeMode

public Async_ContainerEvent async_changeMode(java.lang.String fullName,
                                             Symbol accessMode,
                                             java.util.Dictionary optargs)
change the access rights of a container.
Parameters:
the - name of the DataObject to open.
accessMode - one of the Symbols v_AccessRead, v_AccessWrite
See Also:
changeMode

async_copy

public Async_ContainerEvent async_copy(java.lang.String fullName,
                                       java.lang.String target,
                                       java.util.Dictionary optargs)
Copy one DataObject to new DataObject name.
See Also:
copy

async_rename

public Async_ContainerEvent async_rename(java.lang.String fullName,
                                         java.lang.String newName,
                                         java.util.Dictionary optargs)
Rename a Container or DataObject within its current Container.

Note: the newName is not a full path; it is just the last component of the new name, without any path separator characters.

Parameters:
fullName - the current name of Container/DataObject.
newName - the new name for the Container/DataObject.
See Also:
rename

async_destroy

public Async_ContainerEvent async_destroy(java.lang.String fullName,
                                          java.util.Dictionary optargs)
remove this container and all data objects.

Note: Destroy can succeed even if this container is open in read-only mode.

See Also:
destroy

async_listObjects

public Async_ContainerEvent async_listObjects(java.lang.String fullName,
                                              java.util.Dictionary optargs)
list inner objects and containers.
See Also:
listObjects

async_createContainer

public Async_ContainerEvent async_createContainer(java.lang.String fullName,
                                                  java.util.Dictionary optargs)
Create a new Container.

Note:to create a new Data Object, use async_openObject().

Parameters:
the - name of the new Container.
See Also:
createContainer

async_createDataObject

public Async_ContainerEvent async_createDataObject(java.lang.String fullName,
                                                   Symbol accessMode,
                                                   java.util.Dictionary optargs)
Create a new Data Object and open it.
See Also:
createDataObject

async_openDataObject

public Async_ContainerEvent async_openDataObject(java.lang.String fullName,
                                                 Symbol accessMode,
                                                 boolean ifNoExist,
                                                 boolean truncate,
                                                 java.util.Dictionary optargs)
Open a Data Object.
See Also:
openDataObject

addListener

public void addListener(java.util.EventListener listener)
Add listener for Container event completions.
Parameters:
listener - an Async_ContainerListener

removeListener

public void removeListener(java.util.EventListener listener)
Remove listener for Container event completions.
Parameters:
listener - an Async_ContainerListener

JSR-043: JTAPI-1.4

Send comments to: JSR-43@ectf.org