DefaultOMEROSession (ImageJ2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imagej.omero.DefaultOMEROSession

All Implemented Interfaces:

Closeable, AutoCloseable, OMEROSession
```
public class DefaultOMEROSession
extends Object
implements OMEROSession
```
Helper class for managing OMERO client sessions.

Author:

Curtis Rueden

Constructor Summary

Constructors
Constructor and Description
`DefaultOMEROSession(OMEROLocation credentials, client c, OMEROService omeroService)`
`DefaultOMEROSession(OMEROLocation credentials, OMEROService omeroService)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`omero.api.RawPixelsStorePrx`	`createPixels(OMEROFormat.Metadata meta)` Obtains a raw pixels store for writing to a new image which will be associated with the given metadata.
`client`	`getClient()` Gets the `omero.client` associated with this OMEROSession
`ExperimenterData`	`getExperimenter()` Gets the `Experimenter` associated with this OMEROSession
`Gateway`	`getGateway()` Gets the `Gateway` associated with this OMEROSession
`SecurityContext`	`getSecurityContext()` Gets the `SecurityContext` associated with this OMEROSession
`omero.api.ServiceFactoryPrx`	`getSession()` Gets the `ServiceFactoryPrx` associated with this OMEROSession
`String`	`getSessionID()` Gets the session ID associated with this OMEROSession
`Image`	`loadImage(OMEROFormat.Metadata meta)` Gets an OMERO `Image` descriptor, loading remotely as needed.
`String`	`loadImageName(OMEROFormat.Metadata meta)` Gets the metadata's associated image name, loading remotely as needed.
`Pixels`	`loadPixels(OMEROFormat.Metadata meta)` Gets an OMERO `Pixels` descriptor, loading remotely as needed.
`long`	`loadPixelsID(OMEROFormat.Metadata meta)` Gets the metadata's associated pixels ID, loading remotely as needed.
`omero.api.RawPixelsStorePrx`	`openPixels(OMEROFormat.Metadata meta)` Obtains a raw pixels store for reading from the pixels associated with the given metadata.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DefaultOMEROSession
```
public DefaultOMEROSession(OMEROLocation credentials,
                           OMEROService omeroService)
                    throws ServerError,
                           Glacier2.PermissionDeniedException,
                           Glacier2.CannotCreateSessionException
```
    Throws:
    
    ServerError
    
    Glacier2.PermissionDeniedException
    
    Glacier2.CannotCreateSessionException
  - DefaultOMEROSession
```
public DefaultOMEROSession(OMEROLocation credentials,
                           client c,
                           OMEROService omeroService)
                    throws ServerError,
                           Glacier2.PermissionDeniedException,
                           Glacier2.CannotCreateSessionException
```
    Throws:
    
    ServerError
    
    Glacier2.PermissionDeniedException
    
    Glacier2.CannotCreateSessionException
- Method Detail
  - getClient
```
public client getClient()
```
    Description copied from interface: OMEROSession
    
    Gets the omero.client associated with this OMEROSession
    
    Specified by:
    
    getClient in interface OMEROSession
  - getSession
```
public omero.api.ServiceFactoryPrx getSession()
```
    Description copied from interface: OMEROSession
    
    Gets the ServiceFactoryPrx associated with this OMEROSession
    
    Specified by:
    
    getSession in interface OMEROSession
  - getSecurityContext
```
public SecurityContext getSecurityContext()
```
    Description copied from interface: OMEROSession
    
    Gets the SecurityContext associated with this OMEROSession
    
    Specified by:
    
    getSecurityContext in interface OMEROSession
  - getExperimenter
```
public ExperimenterData getExperimenter()
```
    Description copied from interface: OMEROSession
    
    Gets the Experimenter associated with this OMEROSession
    
    Specified by:
    
    getExperimenter in interface OMEROSession
  - getGateway
```
public Gateway getGateway()
```
    Description copied from interface: OMEROSession
    
    Gets the Gateway associated with this OMEROSession
    
    Specified by:
    
    getGateway in interface OMEROSession
  - getSessionID
```
public String getSessionID()
```
    Description copied from interface: OMEROSession
    
    Gets the session ID associated with this OMEROSession
    
    Specified by:
    
    getSessionID in interface OMEROSession
  - loadPixels
```
public Pixels loadPixels(OMEROFormat.Metadata meta)
                  throws ServerError
```
    Description copied from interface: OMEROSession
    
    Gets an OMERO Pixels descriptor, loading remotely as needed.
    
    Specified by:
    
    loadPixels in interface OMEROSession
    
    Throws:
    
    ServerError
  - loadImage
```
public Image loadImage(OMEROFormat.Metadata meta)
                throws ServerError
```
    Description copied from interface: OMEROSession
    
    Gets an OMERO Image descriptor, loading remotely as needed.
    
    Specified by:
    
    loadImage in interface OMEROSession
    
    Throws:
    
    ServerError
  - loadPixelsID
```
public long loadPixelsID(OMEROFormat.Metadata meta)
                  throws ServerError
```
    Description copied from interface: OMEROSession
    
    Gets the metadata's associated pixels ID, loading remotely as needed.
    
    Specified by:
    
    loadPixelsID in interface OMEROSession
    
    Throws:
    
    ServerError
  - loadImageName
```
public String loadImageName(OMEROFormat.Metadata meta)
                     throws ServerError
```
    Description copied from interface: OMEROSession
    
    Gets the metadata's associated image name, loading remotely as needed.
    
    Specified by:
    
    loadImageName in interface OMEROSession
    
    Throws:
    
    ServerError
  - openPixels
```
public omero.api.RawPixelsStorePrx openPixels(OMEROFormat.Metadata meta)
                                       throws ServerError
```
    Description copied from interface: OMEROSession
    
    Obtains a raw pixels store for reading from the pixels associated with the given metadata.
    
    Specified by:
    
    openPixels in interface OMEROSession
    
    Throws:
    
    ServerError
  - createPixels
```
public omero.api.RawPixelsStorePrx createPixels(OMEROFormat.Metadata meta)
                                         throws ServerError,
                                                FormatException
```
    Description copied from interface: OMEROSession
    
    Obtains a raw pixels store for writing to a new image which will be associated with the given metadata.
    
    Specified by:
    
    createPixels in interface OMEROSession
    
    Throws:
    
    ServerError
    
    FormatException
  - close
```
public void close()
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface OMEROSession

Class DefaultOMEROSession

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultOMEROSession

DefaultOMEROSession

Method Detail

getClient

getSession

getSecurityContext

getExperimenter

getGateway

getSessionID

loadPixels

loadImage

loadPixelsID

loadImageName

openPixels

createPixels

close