javax.sdp
インタフェース SessionDescription

すべてのスーパーインタフェース:
java.lang.Cloneable, java.io.Serializable

public interface SessionDescription
extends java.io.Serializable, java.lang.Cloneable

SessionDescriptionは、Session Description Protocolが定義するデータを表し (IETF RFC 2327参照)、セッションの発信元、クライアントがサポートできる メディアのタイプ、およびクライアントがそのメディアをリスンするホストおよび ポートに関する情報を保持します。 SessionDescriptionはまた、セッションに関するタイミング情報 (例えば開始、終了、リピート、タイムゾーンなど)、およびセッションがサポート する帯域幅も保持します。 SDPの記述についてはIETF RFC2327を参照してください。

バージョン:
1.0

メソッドの概要
 java.lang.Object clone()
          パブリッククローン宣言
 java.lang.String getAttribute(java.lang.String name)
          指定された属性の値を戻します
 java.util.Vector getAttributes(boolean create)
          このDescriptionに対する属性を、AttributeオブジェクトのVectorとして、それらが解析された順番に戻します。
 int getBandwidth(java.lang.String name)
          指定された帯域幅名の整数値を戻します。
 java.util.Vector getBandwidths(boolean create)
          指定されたタイプのBandwidthを戻します。
 Connection getConnection()
          このオブジェクトに関連づけられたコネクション情報を戻します。
 java.util.Vector getEmails(boolean create)
          セッションに関する詳細情報のためにコンタクトをとるemailアドレスを戻します。
 Info getInfo()
          このオブジェクトのinfoフィールド (i=) の値を戻します。
 Key getKey()
          keyデータを戻します。
 java.util.Vector getMediaDescriptions(boolean create)
          MediaDescriptionをセッション記述に追加します。
 Origin getOrigin()
          セッションの発信元に関する情報を戻します。
 java.util.Vector getPhones(boolean create)
          セッションに関する詳細情報のためにコンタクトをとる電話番号を戻します。
 SessionName getSessionName()
          セッションの名前を戻します。
 java.util.Vector getTimeDescriptions(boolean create)
          セッションの開始、停止、繰り返しおよびタイムゾーンの情報を示すTimeFieldを戻します。
 URI getURI()
          セッションに関する詳細情報の場所へのURIを戻します。
 Version getVersion()
          使用中のSDPのバージョンを戻します。
 java.util.Vector getZoneAdjustments(boolean create)
          セッションに対するタイムゾーン調整を戻します。
 void removeAttribute(java.lang.String name)
          値パラメータによって指定された属性を削除します。
 void removeBandwidth(java.lang.String name)
          指定された帯域幅タイプを削除します。
 void setAttribute(java.lang.String name, java.lang.String value)
          指定された属性の値を設定します。
 void setAttributes(java.util.Vector Attributes)
          指定されたAttributeをこのDescriptionオブジェクトに追加します。
 void setBandwidth(java.lang.String name, int value)
          指定された帯域幅タイプの値を設定します。
 void setBandwidths(java.util.Vector bandwidths)
          指定されたタイプのBandwidthの値を設定します。
 void setConnection(Connection conn)
          このエンティティに対するコネクションデータを設定します。
 void setEmails(java.util.Vector emails)
          セッションに関する詳細情報のためにコンタクトをとるemailアドレスを戻します。
 void setInfo(Info i)
          このオブジェクトのi=filedを設定します。
 void setKey(Key key)
          暗号化キー情報を設定します。
 void setMediaDescriptions(java.util.Vector mediaDescriptions)
          セッション記述からすべてのMediaDescriptionsを削除します。
 void setOrigin(Origin origin)
          セッションの発信元に関する情報を設定します。
 void setPhones(java.util.Vector phones)
          セッションに関する詳細情報のためにコンタクトする電話番号を設定します。
 void setSessionName(SessionName sessionName)
          セッションの名前を設定します。
 void setTimeDescriptions(java.util.Vector times)
          セッションの開始、停止、繰り返しおよびタイムゾーンの情報を示すTimeFieldを設定します。
 void setURI(URI uri)
          セッションに関する詳細の場所へのuriを設定します。
 void setVersion(Version v)
          使用中のSDPのバージョンを設定します。
 void setZoneAdjustments(java.util.Vector zoneAdjustments)
          TimeFieldに対するタイムゾーン調整を設定します。
 

メソッドの詳細

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
パブリッククローン宣言

戻り値:
Object
例外:
java.lang.CloneNotSupportedException - クローンメソッドがサポートされていない場合

getVersion

public Version getVersion()
使用中のSDPのバージョンを戻します。

戻り値:
整数値(設定されていない場合は-1)

setVersion

public void setVersion(Version v)
                throws SdpException
使用中のSDPのバージョンを設定します。 これは、SDPデータのv= fieldに対応します。

パラメータ:
v - version - 整数値のバージョン
例外:
SdpException - バージョンがnullの場合

getOrigin

public Origin getOrigin()
セッションの発信元に関する情報を戻します。 これは、SDPデータのo= fieldに対応します。

戻り値:
発信元データ

setOrigin

public void setOrigin(Origin origin)
               throws SdpException
セッションの発信元に関する情報を設定します。 これは、SDPデータのo= fieldに対応します。

パラメータ:
origin - - 発信元データ
例外:
SdpException - Originがnullの場合

getSessionName

public SessionName getSessionName()
セッションの名前を戻します。 これは、SDPデータのs= fieldに対応します。

戻り値:
セッション名

setSessionName

public void setSessionName(SessionName sessionName)
                    throws SdpException
セッションの名前を設定します。 これは、SDPデータのs= fieldに対応します。

パラメータ:
sessionName - name - セッション名
例外:
SdpException - SessionNameがnullの場合

getInfo

public Info getInfo()
このオブジェクトのinfoフィールド (i=) の値を戻します。

戻り値:
info

setInfo

public void setInfo(Info i)
             throws SdpException
このオブジェクトのi=filedを設定します。

パラメータ:
i - - 新しいi=value、nullの場合はフィールドを削除します
例外:
SdpException - infoがnullの場合

getURI

public URI getURI()
セッションに関する詳細情報の場所へのURIを戻します。 これは、SDPデータのu= fieldに対応します。

戻り値:
the uri.

setURI

public void setURI(URI uri)
            throws SdpException
セッションに関する詳細の場所へのuriを設定します。 これは、SDPデータのu= fieldに対応します。

パラメータ:
uri - - the uri.
例外:
SdpException - URIがnullの場合

getEmails

public java.util.Vector getEmails(boolean create)
                           throws SdpParseException
セッションに関する詳細情報のためにコンタクトをとるemailアドレスを戻します。 これは、SDPデータのe= fieldに対応します。

パラメータ:
create - 設定するブール値
戻り値:
emailアドレス
例外:
SdpException
SdpParseException

setEmails

public void setEmails(java.util.Vector emails)
               throws SdpException
セッションに関する詳細情報のためにコンタクトをとるemailアドレスを戻します。 これは、SDPデータのe= fieldに対応する。

パラメータ:
emails - - emailアドレス
例外:
SdpException - Vectorがnullの場合

getPhones

public java.util.Vector getPhones(boolean create)
                           throws SdpException
セッションに関する詳細情報のためにコンタクトをとる電話番号を戻します。 これは、SDPデータのp= fieldに対応します。

パラメータ:
create - 設定するブール値
戻り値:
電話番号
例外:
SdpException

setPhones

public void setPhones(java.util.Vector phones)
               throws SdpException
セッションに関する詳細情報のためにコンタクトする電話番号を設定します。 これは、SDPデータのp= fieldに対応します。

パラメータ:
phones - - 電話番号
例外:
SdpException - Vectorがnullの場合

getTimeDescriptions

public java.util.Vector getTimeDescriptions(boolean create)
                                     throws SdpException
セッションの開始、停止、繰り返しおよびタイムゾーンの情報を示すTimeFieldを戻します。 これは、SDPデータのt= fieldに対応します。

パラメータ:
create - 設定するブール値
戻り値:
the Time Field.
例外:
SdpException

setTimeDescriptions

public void setTimeDescriptions(java.util.Vector times)
                         throws SdpException
セッションの開始、停止、繰り返しおよびタイムゾーンの情報を示すTimeFieldを設定します。 これは、SDPデータのt= fieldに対応します。

パラメータ:
times - - the TimeField.
例外:
SdpException - Vectorがnullの場合

getZoneAdjustments

public java.util.Vector getZoneAdjustments(boolean create)
                                    throws SdpException
セッションに対するタイムゾーン調整を戻します。

パラメータ:
create - 設定するブール値
戻り値:
a ゾーン調整を含むHashtable。そこでkeyはAdjusted Time Zoneで、値はオフセットです。
例外:
SdpException

setZoneAdjustments

public void setZoneAdjustments(java.util.Vector zoneAdjustments)
                        throws SdpException
TimeFieldに対するタイムゾーン調整を設定します。

パラメータ:
zoneAdjustments - ゾーン調整を含むHashtable。 そこでkeyはAdjusted Time Zoneで、値はオフセットです。
例外:
SdpException - Vectorがnullの場合

getConnection

public Connection getConnection()
このオブジェクトに関連づけられたコネクション情報を戻します。 これは、すべてのMediaオブジェクトがコネクションオブジェクトを所有する場合、 SessionDescriptionに対してnullになるかもしれません。また対応するセッションコネクションが 非nullの場合は、Mediaオブジェクトに対してnullになるかもしれません。

戻り値:
connection

setConnection

public void setConnection(Connection conn)
                   throws SdpException
このエンティティに対するコネクションデータを設定します。

パラメータ:
conn - Connection
例外:
SdpException - パラメータがnullの場合

getBandwidths

public java.util.Vector getBandwidths(boolean create)
指定されたタイプのBandwidthを戻します。

パラメータ:
create - 戻すBandwidthのタイプ
戻り値:
Bandwidthまたは、未定義の場合はnull

setBandwidths

public void setBandwidths(java.util.Vector bandwidths)
                   throws SdpException
指定されたタイプのBandwidthの値を設定します。

パラメータ:
bandwidths -
例外:
SdpException - Vectorがnullの場合

getBandwidth

public int getBandwidth(java.lang.String name)
                 throws SdpParseException
指定された帯域幅名の整数値を戻します。

パラメータ:
name - - 帯域幅タイプの名前
戻り値:
指定された帯域幅の値
例外:
SdpParseException

setBandwidth

public void setBandwidth(java.lang.String name,
                         int value)
                  throws SdpException
指定された帯域幅タイプの値を設定します。

パラメータ:
name - - 帯域幅タイプの名前
value - - 指定された帯域幅の値
例外:
SdpException - 名前がnullの場合

removeBandwidth

public void removeBandwidth(java.lang.String name)
指定された帯域幅タイプを削除します。

パラメータ:
name - name - 帯域幅タイプの名前

getKey

public Key getKey()
keyデータを戻します。

戻り値:
key

setKey

public void setKey(Key key)
            throws SdpException
暗号化キー情報を設定します。 これは、ラインに含まれるメソッドおよび暗号化キーで構成されます。

パラメータ:
key - - 暗号化キーデータ。メソッドに応じてnullになる場合があります。
例外:
SdpException - パラメータがnullの場合

getAttribute

public java.lang.String getAttribute(java.lang.String name)
                              throws SdpParseException
指定された属性の値を戻します

パラメータ:
name - - 属性の名前
戻り値:
指定された属性の値
例外:
SdpParseException

getAttributes

public java.util.Vector getAttributes(boolean create)
このDescriptionに対する属性を、AttributeオブジェクトのVectorとして、それらが解析された順番に戻します。

パラメータ:
create - - このDescriptionに対する属性が存在しない場合に、nullを戻すか、 新しい空のVectorを戻すかを指定します。
戻り値:
このDescriptionに対する属性

removeAttribute

public void removeAttribute(java.lang.String name)
値パラメータによって指定された属性を削除します。

パラメータ:
name - name - 属性の名前

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.String value)
                  throws SdpException
指定された属性の値を設定します。

パラメータ:
name - - 属性の名前
value - - 指定された属性の値
例外:
SdpException - 名前または値がnullの場合

setAttributes

public void setAttributes(java.util.Vector Attributes)
                   throws SdpException
指定されたAttributeをこのDescriptionオブジェクトに追加します。

パラメータ:
Attributes - - 追加する属性
例外:
SdpException - Vectorがnullの場合

getMediaDescriptions

public java.util.Vector getMediaDescriptions(boolean create)
                                      throws SdpException
MediaDescriptionをセッション記述に追加します。これらは、SDPデータのm=fieldsに対応します。

パラメータ:
create - 設定するブール値
戻り値:
media - 追加するフィールド
例外:
SdpException

setMediaDescriptions

public void setMediaDescriptions(java.util.Vector mediaDescriptions)
                          throws SdpException
セッション記述からすべてのMediaDescriptionsを削除します。

パラメータ:
mediaDescriptions - to set
例外:
SdpException - パラメータがnullの場合