You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@labs.apache.org by gs...@apache.org on 2008/05/01 13:55:46 UTC
svn commit: r652484 -
/labs/vysper/src/main/java/org/apache/vysper/xmpp/server/SessionContext.java
Author: gseitz
Date: Thu May 1 04:55:46 2008
New Revision: 652484
URL: http://svn.apache.org/viewvc?rev=652484&view=rev
Log:
[vysper] added javadocs
Modified:
labs/vysper/src/main/java/org/apache/vysper/xmpp/server/SessionContext.java
Modified: labs/vysper/src/main/java/org/apache/vysper/xmpp/server/SessionContext.java
URL: http://svn.apache.org/viewvc/labs/vysper/src/main/java/org/apache/vysper/xmpp/server/SessionContext.java?rev=652484&r1=652483&r2=652484&view=diff
==============================================================================
--- labs/vysper/src/main/java/org/apache/vysper/xmpp/server/SessionContext.java (original)
+++ labs/vysper/src/main/java/org/apache/vysper/xmpp/server/SessionContext.java Thu May 1 04:55:46 2008
@@ -25,57 +25,112 @@
* provides the session with its context data
*/
public interface SessionContext {
- ServerRuntimeContext getServerRuntimeContext();
+ /**
+ * Gets the {@link ServerRuntimeContext}.
+ *
+ * @return the {@link ServerRuntimeContext}
+ */
+ ServerRuntimeContext getServerRuntimeContext();
+
+ /**
+ * FALSE iff _this_ server has initiated the connection (to another server),
+ * and _not_ the remote side (client/server) initiated the session. for
+ * common client/server connections this returns TRUE.
+ *
+ * @return
+ */
+ boolean isRemotelyInitiatedSession();
+
+ /**
+ * @return the initiating {@link Entity}
+ */
+ Entity getInitiatingEntity();
+
+ /**
+ * Sets the initiating entity.
+ *
+ * @param entity
+ */
+ void setInitiatingEntity(Entity entity);
+
+ /**
+ * @return <code>true</code> if this session is handling server-to-server
+ * communication (namespace "jabber:server").
+ */
+ boolean isServerToServer();
+
+ /**
+ * Set this session to handle server-to-server communication.
+ */
+ void setServerToServer();
+
+ /**
+ * Set this session to handle client-to-server communication.
+ */
+ void setClientToServer();
+
+ /**
+ * @return the state of this session
+ */
+ SessionState getState();
+
+ /**
+ * Returns the id for this session, which is unique inside a server instance
+ * and across all hosted services.
+ *
+ * @return this session's id
+ */
+ String getSessionId();
+
+ /**
+ * Gets the default value for the 'xml:lang' attribute.
+ *
+ * @return the default language code
+ */
+ String getXMLLang();
+
+ /**
+ * Sets the default value for the 'xml:lang' attribute.
+ *
+ * @param languageCode
+ * the default language code
+ */
+ void setXMLLang(String languageCode);
+
+ StanzaWriter getResponseWriter();
+
+ /**
+ * Ends this session and the underlying TCP connection.
+ */
+ void endSession();
+
+ /**
+ * Gets the JID of the server this session is associated with.
+ *
+ * @return the server's JID
+ */
+ Entity getServerJID();
+
+ /**
+ * signals the underlying transport to handle TLS handshake
+ */
+ void switchToTLS();
+
+ /**
+ * this method signals that from now on a new <stream:stream>... xml stream
+ * begins. this is used at the very beginning of the session, then again
+ * after encryption and after authentication. see RFC3920.7.5.7 and
+ * RFC3920.6.2
+ */
+ void setIsReopeningXMLStream();
+
+ /**
+ * binds a resource to the session
+ *
+ * @return resource id
+ * @throws BindException
+ * when binding fails
+ */
+ String bindResource() throws BindException;
- /**
- * FALSE iff _this_ server has initiated the connection (to another server),
- * and _not_ the remote side (client/server) initiated the session.
- * for common client/server connections this returns TRUE.
- * @return
- */
- boolean isRemotelyInitiatedSession();
- Entity getInitiatingEntity();
- void setInitiatingEntity(Entity entity);
-
- /**
- * if this session is handling server-to-server communication
- * (namespace "jabber:server"
- * @return
- */
- boolean isServerToServer();
- void setServerToServer();
- void setClientToServer();
-
- SessionState getState();
-
- String getSessionId();
-
- String getXMLLang();
- void setXMLLang(String languageCode);
-
- StanzaWriter getResponseWriter();
-
- void endSession();
-
- Entity getServerJID();
-
- /**
- * signals the underlying transport to handle TLS handshake
- */
- void switchToTLS();
-
- /**
- * this method signals that from now on a new <stream:stream>... xml stream begins.
- * this is used at the very beginning of the session, then again after encryption and after
- * authentication. see RFC3920.7.5.7 and RFC3920.6.2
- */
- void setIsReopeningXMLStream();
-
- /**
- * binds a resource to the session
- * @return resource id
- * @throws BindException when binding fails
- */
- String bindResource() throws BindException;
-
}
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@labs.apache.org
For additional commands, e-mail: commits-help@labs.apache.org