NotesLocation (Domingo 1.5.2 API)

java.lang.Object
- de.jakop.lotus.domingo.map.NotesLocation

public final class NotesLocation
extends Object

Location of a Notes database.

Author:: Kurt Riede

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`HTTP_PROTOCOL` Protocol of a notes location.
`static String`	`LOCAL_HOST` Standard identifier for the local host.
`static String`	`NOTES_PROTOCOL` Protocol of a notes location.

Constructor Summary

Constructors
Constructor and Description
`NotesLocation(NotesLocation context, String path)` Constructor.
`NotesLocation(NotesLocation context, String server, String path)` Creates a new local location.
`NotesLocation(String locationUri)` Constructor.
`NotesLocation(String server, String path)` Constructor for local locations.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`String`	`getHost()` Returns the host of the notes location or `null` if it's an IIOP location.
`String`	`getIIOPPasswd()` Deprecated. use `getPassword()` instead
`String`	`getIIOPUser()` Deprecated. use `getUsername()` instead
`static NotesLocation`	`getInstance(NotesLocation context, String server, String path)` Factory method for local Location.
`static NotesLocation`	`getInstance(String location)` Factory method for Location objects.
`NotesLocation`	`getLocalLocation()` Returns the local location corresponding to this location.
`String`	`getLocalServer()` Returns a string representing the local server.
`String`	`getPassword()` Returns the IIOP Password.
`String`	`getPath()` Returns the path of the notes location.
`protected String`	`getPathSep()` Returns the separator string between host and path in locations.
`String`	`getProtocol()` Returns the protocol of the location.
`String`	`getServer()` Returns the server part of a location.
`String`	`getUsername()` Returns the IIOP Username.
`boolean`	`isHttp()` Checks if the notes location is using the HTTP protocol.
`boolean`	`isIIOP()` Checks if the notes location is a IIOP location or not.
`boolean`	`isLocal()` Checks if a notes location is local or not.
`protected void`	`setLocation(String locationUri)` Sets the location string.
`String`	`toString()`

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

- Field Detail
  - NOTES_PROTOCOL
```
public static final String NOTES_PROTOCOL
```
    Protocol of a notes location.
    
    See Also:
    
    Constant Field Values
  - HTTP_PROTOCOL
```
public static final String HTTP_PROTOCOL
```
    Protocol of a notes location.
    
    See Also:
    
    Constant Field Values
  - LOCAL_HOST
```
public static final String LOCAL_HOST
```
    Standard identifier for the local host.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - NotesLocation
```
public NotesLocation(String locationUri)
```
    Constructor.
    
    Parameters:
    
    locationUri - URI of location of database.
  - NotesLocation
```
public NotesLocation(NotesLocation context,
                     String path)
```
    Constructor.
    
    Parameters:
    
    context - parent location
    
    path - path relative to context
  - NotesLocation
```
public NotesLocation(NotesLocation context,
                     String server,
                     String path)
```
    Creates a new local location. This method doesn't handle IIOP locations.
    
    Parameters:
    
    context - parent location
    
    server - the server
    
    path - path relative to context
  - NotesLocation
```
public NotesLocation(String server,
                     String path)
```
    Constructor for local locations.
    
    Parameters:
    
    server - the server
    
    path - the path
- Method Detail
  - getInstance
```
public static NotesLocation getInstance(String location)
```
    Factory method for Location objects.
    
    Parameters:
    
    location - the location as url-like string
    
    Returns:
    
    the location object
  - getInstance
```
public static NotesLocation getInstance(NotesLocation context,
                                        String server,
                                        String path)
```
    Factory method for local Location.
    
    Parameters:
    
    context - parent location
    
    server - the server
    
    path - the path
    
    Returns:
    
    the new Location
  - setLocation
```
protected void setLocation(String locationUri)
```
    Sets the location string.
    
    Parameters:
    
    locationUri - URI of location of database.
  - getIIOPPasswd
```
public String getIIOPPasswd()
```
    Deprecated. use getPassword() instead
    
    Returns the IIOP Password.
    
    Returns:
    
    String
  - getPassword
```
public String getPassword()
```
    Returns the IIOP Password.
    
    Returns:
    
    String
  - getIIOPUser
```
public String getIIOPUser()
```
    Deprecated. use getUsername() instead
    
    Returns the IIOP Username.
    
    Returns:
    
    String
  - getUsername
```
public String getUsername()
```
    Returns the IIOP Username.
    
    Returns:
    
    String
  - getPath
```
public String getPath()
```
    Returns the path of the notes location.
    
    Returns:
    
    the path of the notes location.
  - getLocalLocation
```
public NotesLocation getLocalLocation()
```
    Returns the local location corresponding to this location. If the location is already local, this instance is returned. If the location is not local, a new location is returned where the host of the location is changed to the local host.
    
    Returns:
    
    local location
  - isLocal
```
public boolean isLocal()
```
    Checks if a notes location is local or not.
    
    Returns:
    
    true if the location is local, else false
  - isIIOP
```
public boolean isIIOP()
```
    Checks if the notes location is a IIOP location or not.
    
    Returns:
    
    true if it is a IIOP location, else false
  - isHttp
```
public boolean isHttp()
```
    Checks if the notes location is using the HTTP protocol.
    
    Returns:
    
    true if the protocol is HTTP, else false
  - getHost
```
public String getHost()
```
    Returns the host of the notes location or null if it's an IIOP location.
    
    Returns:
    
    the host of the notes location.
  - getServer
```
public String getServer()
```
    Returns the server part of a location. If the location is a local location or an IIOP location, then the server the empty string, else the name of the server.
    
    Returns:
    
    server part of a location
  - getLocalServer
```
public String getLocalServer()
```
    Returns a string representing the local server. In case of DIIOP (Corba), this must be the empty string, in case of local call this must be the string "local".
    
    Returns:
    
    local server
  - getPathSep
```
protected String getPathSep()
```
    Returns the separator string between host and path in locations.
    
    Returns:
    
    separator string between host and path
  - getProtocol
```
public String getProtocol()
```
    Returns the protocol of the location.
    
    Returns:
    
    protocol of location
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the location as a string

Class NotesLocation

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NOTES_PROTOCOL

HTTP_PROTOCOL

LOCAL_HOST

Constructor Detail

NotesLocation

NotesLocation

NotesLocation

NotesLocation

Method Detail

getInstance

getInstance

setLocation

getIIOPPasswd

getPassword

getIIOPUser

getUsername

getPath

getLocalLocation

isLocal

isIIOP

isHttp

getHost

getServer

getLocalServer

getPathSep

getProtocol

toString