oracle.javatools.db.ora
Class DatabaseLink

java.lang.Object
  oracle.javatools.db.AbstractDBObject
      oracle.javatools.db.AbstractBuildableObject
          oracle.javatools.db.AbstractSchemaObject
              oracle.javatools.db.ora.DatabaseLink

All Implemented Interfaces:

DBObject, SchemaObject, SystemObject, Copyable, DynamicPropertySet

public class DatabaseLink
extends AbstractSchemaObject

Model of a database DatabaseLink. A DatabaseLink is a reference to another database.

Nested Class Summary

Nested classes/interfaces inherited from class oracle.javatools.db.AbstractDBObject

AbstractDBObject.ChildSupport

Field Summary

static java.lang.String	PUBLIC_TYPE
static java.lang.String	TYPE

Fields inherited from interface oracle.javatools.db.DBObject

COMMENT

Constructor Summary

DatabaseLink()
Construct a new DatabaseLink

DatabaseLink(java.lang.String name, Schema schema, DBObjectID id)
Construct a new DatabaseLink .

Method Summary

DBObject	copyTo(DBObject target, DBObject copyParent, IDPolicy idPolicy) Internal copy method used by the API to perform copy operations.
protected void	copyToImpl(DatabaseLink copy, DBObject copyParent, IDPolicy idPolicy)
boolean	equals(java.lang.Object obj)
protected boolean	equalsImpl(DatabaseLink target)
java.lang.String	getAuthentificationPassword() Retrieves the password for the authentification user.
java.lang.String	getAuthentificationUser() Deprecated.
java.lang.String	getAuthentificationUsername() Retrieves the user name for authentificating shared links
java.lang.String	getCreated() Retrieves the dblink creation date.
DBObjectProvider	getDBLink() Retrieves the database referenced by this DatabaseLink.
java.lang.String	getHost() Retrieves the SQL*Net string for connect.
java.lang.String	getPassword() Retrieves the password for the user.
java.lang.String	getType() Returns the type of this object.
java.lang.String	getUsername() Retrieves the user name for the connention
boolean	isCurrentUser() Whether this database link is connected via the current user.
boolean	isPublic() Whether this database link is public.
boolean	isShared() Whether this database link is shared.
void	setAuthentificationPassword(java.lang.String password) Set the password for the authentification user
void	setAuthentificationUsername(java.lang.String username) Set the user name for authentificating shared links
void	setCreated(java.lang.String created) Set the dblink creation date
void	setCurrentUser(boolean currentUser) Sets whether this database link is connected via the current user.
void	setHost(java.lang.String host) Set the SQL*Net string for connect.
void	setPassword(java.lang.String password) Set the password for the connention
void	setPublic(boolean pub) Sets whether this database link is public.
void	setShared(boolean shared) Sets whether this database link is shared.
void	setUsername(java.lang.String username) Set the user name for the connention

Methods inherited from class oracle.javatools.db.AbstractSchemaObject

addObjectListener, copyToImpl, equalsImpl, getParent, getSchema, removeObjectListener, setSchema

Methods inherited from class oracle.javatools.db.AbstractBuildableObject

addObjectListener, checkInit, checkInit, checkInitEx, copyToImpl, equalsImpl, fireObjectUpdated, getOwnedObjectsImpl, getProperties, getProperty, getProperty, getReferenceIDsImpl, needsInitialization, removeObjectListener, setProperties, setProperty

Methods inherited from class oracle.javatools.db.AbstractDBObject

changeParent, compareToImpl, copyObject, copyTo, copyTo, copyTo, copyToImpl, equalsImpl, findOwnedObject, findOwnedObject, findOwnedObject, getChildSupport, getID, getName, getOwnedObjects, getOwnedObjects, getReferenceIDs, hashCode, includeOwnedObject, includesType, includesType, removeThisAsParent, replaceReferenceIDs, setID, setName, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.javatools.db.SystemObject

addObjectListener, fireObjectUpdated, removeObjectListener

Methods inherited from interface oracle.javatools.db.DBObject

copyTo, copyTo, copyTo, findOwnedObject, findOwnedObject, getID, getName, getOwnedObjects, getOwnedObjects, getReferenceIDs, replaceReferenceIDs, setID, setName

Methods inherited from interface oracle.javatools.util.DynamicPropertySet

getProperties, getProperty, getProperty, setProperties, setProperty

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

PUBLIC_TYPE

public static final java.lang.String PUBLIC_TYPE

See Also:

Constant Field Values

Constructor Detail

DatabaseLink

public DatabaseLink()

Construct a new DatabaseLink

DatabaseLink

public DatabaseLink(java.lang.String name,
                    Schema schema,
                    DBObjectID id)

Construct a new DatabaseLink .

Parameters:

name - the name of the new DatabaseLink

schema - the schema containing the DatabaseLink

id - the id of this object.

Method Detail

getType

public java.lang.String getType()

Description copied from interface: DBObject

Returns the type of this object. Valid types include things like tables, views, synonyms, and columns.

Returns:

a string describing the type of object.

isPublic

public boolean isPublic()

Whether this database link is public.

Returns:

a boolean value indicating whether this schema is public

setPublic

public void setPublic(boolean pub)

Sets whether this database link is public.

Parameters:

pub - a boolean value indicating whether this schema is public

isShared

public boolean isShared()

Whether this database link is shared.

Returns:

a boolean value indicating whether this schema is shared

setShared

public void setShared(boolean shared)

Sets whether this database link is shared.

Parameters:

pub - a boolean value indicating whether this schema is shared

isCurrentUser

public boolean isCurrentUser()

Whether this database link is connected via the current user.

Returns:

a boolean value indicating whether this schema is connected via the current user.

setCurrentUser

public void setCurrentUser(boolean currentUser)

Sets whether this database link is connected via the current user.

Parameters:

pub - a boolean value indicating whether this schema is connected via the current user.

getUsername

public java.lang.String getUsername()

Retrieves the user name for the connention

setUsername

public void setUsername(java.lang.String username)

Set the user name for the connention

getPassword

public java.lang.String getPassword()

Retrieves the password for the user.

setPassword

public void setPassword(java.lang.String password)

Set the password for the connention

getHost

public java.lang.String getHost()

Retrieves the SQL*Net string for connect.

setHost

public void setHost(java.lang.String host)

Set the SQL*Net string for connect.

getCreated

public java.lang.String getCreated()

Retrieves the dblink creation date.

setCreated

public void setCreated(java.lang.String created)

Set the dblink creation date

getDBLink

public DBObjectProvider getDBLink()

Retrieves the database referenced by this DatabaseLink.

This is a convenience method which will (if it can) return a DBObjectProvider for the Objects at thoe other end of the link. To do this for an online database, it mus be able to open a connection. This will require at least a username, password and host.

The password must be populated by the API user, it cannot be loaded from the catalog.

getAuthentificationUser

@Deprecated
public java.lang.String getAuthentificationUser()

Deprecated.

getAuthentificationUsername

public java.lang.String getAuthentificationUsername()

Retrieves the user name for authentificating shared links

setAuthentificationUsername

public void setAuthentificationUsername(java.lang.String username)

Set the user name for authentificating shared links

getAuthentificationPassword

public java.lang.String getAuthentificationPassword()

Retrieves the password for the authentification user.

setAuthentificationPassword

public void setAuthentificationPassword(java.lang.String password)

Set the password for the authentification user

copyTo

public DBObject copyTo(DBObject target,
                       DBObject copyParent,
                       IDPolicy idPolicy)

Description copied from class: AbstractDBObject

Internal copy method used by the API to perform copy operations. All objects must implement this method if they are instantiable objects. Abstract objects (e.g. Relation) must NOT implement this method. The implementation should delegate to the copyToImpl method to copy the actual properties.

This method does not fix internal reference ids on copy. That is done by the calling DBObject.copyTo(DBObject, IDPolicy) method.

Specified by:

copyTo in class AbstractDBObject

See Also:

DBObject.copyTo(java.lang.Object), DBObject.copyTo(DBObject, boolean), AbstractDBObject.copyToImpl(oracle.javatools.db.AbstractDBObject, oracle.javatools.db.DBObject, oracle.javatools.db.IDPolicy)

copyToImpl

protected void copyToImpl(DatabaseLink copy,
                          DBObject copyParent,
                          IDPolicy idPolicy)

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

equalsImpl

protected boolean equalsImpl(DatabaseLink target)