org.apache.zeppelin.socket

Class NotebookServer

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.eclipse.jetty.websocket.servlet.WebSocketServlet

org.apache.zeppelin.socket.NotebookServer

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig, org.apache.zeppelin.display.AngularObjectRegistryListener, org.apache.zeppelin.interpreter.remote.RemoteInterpreterProcessListener, JobListenerFactory, NotebookSocketListener

public class NotebookServer
extends org.eclipse.jetty.websocket.servlet.WebSocketServlet
implements NotebookSocketListener, JobListenerFactory, org.apache.zeppelin.display.AngularObjectRegistryListener, org.apache.zeppelin.interpreter.remote.RemoteInterpreterProcessListener

Zeppelin websocket service.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NotebookServer.ParagraphListenerImpl Need description here.

Constructor Summary

Constructors

Constructor and Description
NotebookServer()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	angularObjectClientBind(NotebookSocket conn, HashSet<String> userAndRoles, Notebook notebook, Message fromMessage) Push the given Angular variable to the target interpreter angular registry given a noteId and a paragraph id
protected void	angularObjectClientUnbind(NotebookSocket conn, HashSet<String> userAndRoles, Notebook notebook, Message fromMessage) Remove the given Angular variable to the target interpreter(s) angular registry given a noteId and an optional list of paragraph id(s)
void	broadcastNote(Note note)
void	broadcastNoteList(org.apache.zeppelin.user.AuthenticationInfo subject)
void	broadcastReloadedNoteList(org.apache.zeppelin.user.AuthenticationInfo subject)
boolean	checkOrigin(javax.servlet.http.HttpServletRequest request, String origin)
void	configure(org.eclipse.jetty.websocket.servlet.WebSocketServletFactory factory)
protected Message	deserializeMessage(String msg)
NotebookSocket	doWebSocketConnect(javax.servlet.http.HttpServletRequest req, String protocol)
List<Map<String,String>>	generateNotebooksInfo(boolean needsReload, org.apache.zeppelin.user.AuthenticationInfo subject)
ParagraphJobListener	getParagraphJobListener(Note note)
protected Note	importNote(NotebookSocket conn, HashSet<String> userAndRoles, Notebook notebook, Message fromMessage)
void	onAdd(String interpreterGroupId, org.apache.zeppelin.display.AngularObject object)
void	onClose(NotebookSocket conn, int code, String reason)
void	onMessage(NotebookSocket conn, String msg)
void	onOpen(NotebookSocket conn)
void	onOutputAppend(String noteId, String paragraphId, String output) This callback is for the paragraph that runs on ZeppelinServer
void	onOutputUpdated(String noteId, String paragraphId, String output) This callback is for the paragraph that runs on ZeppelinServer
void	onRemove(String interpreterGroupId, String name, String noteId, String paragraphId)
void	onUpdate(String interpreterGroupId, org.apache.zeppelin.display.AngularObject object)
protected String	serializeMessage(Message m)
void	unicastNoteList(NotebookSocket conn, org.apache.zeppelin.user.AuthenticationInfo subject)

Methods inherited from class org.eclipse.jetty.websocket.servlet.WebSocketServlet

destroy, init, service

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service

Methods inherited from class javax.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Constructor Detail

NotebookServer

public NotebookServer()

Method Detail

configure

public void configure(org.eclipse.jetty.websocket.servlet.WebSocketServletFactory factory)

Specified by:

configure in class org.eclipse.jetty.websocket.servlet.WebSocketServlet

checkOrigin

public boolean checkOrigin(javax.servlet.http.HttpServletRequest request,
                  String origin)

doWebSocketConnect

public NotebookSocket doWebSocketConnect(javax.servlet.http.HttpServletRequest req,
                                String protocol)

onOpen

public void onOpen(NotebookSocket conn)

Specified by:

onOpen in interface NotebookSocketListener

onMessage

public void onMessage(NotebookSocket conn,
             String msg)

Specified by:

onMessage in interface NotebookSocketListener

onClose

public void onClose(NotebookSocket conn,
           int code,
           String reason)

Specified by:

onClose in interface NotebookSocketListener

deserializeMessage

protected Message deserializeMessage(String msg)

serializeMessage

protected String serializeMessage(Message m)

generateNotebooksInfo

public List<Map<String,String>> generateNotebooksInfo(boolean needsReload,
                                             org.apache.zeppelin.user.AuthenticationInfo subject)

broadcastNote

public void broadcastNote(Note note)

broadcastNoteList

public void broadcastNoteList(org.apache.zeppelin.user.AuthenticationInfo subject)

unicastNoteList

public void unicastNoteList(NotebookSocket conn,
                   org.apache.zeppelin.user.AuthenticationInfo subject)

broadcastReloadedNoteList

public void broadcastReloadedNoteList(org.apache.zeppelin.user.AuthenticationInfo subject)

importNote

protected Note importNote(NotebookSocket conn,
              HashSet<String> userAndRoles,
              Notebook notebook,
              Message fromMessage)
                   throws IOException

Throws:

IOException

angularObjectClientBind

protected void angularObjectClientBind(NotebookSocket conn,
                           HashSet<String> userAndRoles,
                           Notebook notebook,
                           Message fromMessage)
                                throws Exception

Push the given Angular variable to the target interpreter angular registry given a noteId and a paragraph id

Parameters:

conn -

notebook -

fromMessage -

Throws:

Exception

angularObjectClientUnbind

protected void angularObjectClientUnbind(NotebookSocket conn,
                             HashSet<String> userAndRoles,
                             Notebook notebook,
                             Message fromMessage)
                                  throws Exception

Remove the given Angular variable to the target interpreter(s) angular registry given a noteId and an optional list of paragraph id(s)

Parameters:

conn -

notebook -

fromMessage -

Throws:

Exception

onOutputAppend

public void onOutputAppend(String noteId,
                  String paragraphId,
                  String output)

This callback is for the paragraph that runs on ZeppelinServer

Specified by:

onOutputAppend in interface org.apache.zeppelin.interpreter.remote.RemoteInterpreterProcessListener

Parameters:

noteId -

paragraphId -

output - output to append

onOutputUpdated

public void onOutputUpdated(String noteId,
                   String paragraphId,
                   String output)

This callback is for the paragraph that runs on ZeppelinServer

Specified by:

onOutputUpdated in interface org.apache.zeppelin.interpreter.remote.RemoteInterpreterProcessListener

Parameters:

noteId -

paragraphId -

output - output to update (replace)

getParagraphJobListener

public ParagraphJobListener getParagraphJobListener(Note note)

Specified by:

getParagraphJobListener in interface JobListenerFactory

onAdd

public void onAdd(String interpreterGroupId,
         org.apache.zeppelin.display.AngularObject object)

Specified by:

onAdd in interface org.apache.zeppelin.display.AngularObjectRegistryListener

onUpdate

public void onUpdate(String interpreterGroupId,
            org.apache.zeppelin.display.AngularObject object)

Specified by:

onUpdate in interface org.apache.zeppelin.display.AngularObjectRegistryListener

onRemove

public void onRemove(String interpreterGroupId,
            String name,
            String noteId,
            String paragraphId)

Specified by:

onRemove in interface org.apache.zeppelin.display.AngularObjectRegistryListener