Skip navigation links

Oracle® Fusion Middleware Remote Intradoc Client (RIDC) Java API Reference
11g Release 1 (11.1.1)

E17274-01


oracle.stellent.ridc.convenience.adf.mbeans
Class IdcConnection

java.lang.Object
  extended by oracle.stellent.ridc.convenience.adf.mbeans.IdcConnection

All Implemented Interfaces:
javax.naming.Referenceable

public class IdcConnection
extends java.lang.Object
implements javax.naming.Referenceable

IdcConnection is a place holder for all Content Server Connection properties.


Field Summary
static java.lang.String IDC_CONNECTION_KEY_PREFIX
           

 

Constructor Summary
IdcConnection()
          Default Constructor.
IdcConnection(javax.naming.Reference ref)
          Constructor that takes in a jndi reference.

 

Method Summary
static IdcConnection create(javax.naming.Reference ref, javax.naming.Name name, javax.naming.Context nameCtx, java.util.Hashtable<?,?> environment)
          Create an an IdcConnection from the given reference using the given name, context and environment properties.
 boolean equals(java.lang.Object o)
           
 java.util.Map<java.lang.String,java.lang.String> getConfigProperties()
          Get the configuration properties of the IDC Connection.
 java.lang.String getConnectionName()
           
 java.lang.String getConnectionUrl()
           
 java.lang.String getProperty(java.lang.String name)
          Retrieve a property value by name
 javax.naming.Reference getReference()
          
 int getSocketTimeout()
           
 int hashCode()
           
 boolean isNewConnection()
          Is this a new connection or an already existing one?
 void setConfigParameters(java.util.Map<java.lang.String,java.lang.String> configParams)
          Set the configuration parameters of the IDC Connection.
 void setConnectionName(java.lang.String connectionName)
           
 void setConnectionUrl(java.lang.String connectionUrl)
           
 void setProperty(java.lang.String name, java.lang.String value)
          Set a property name and value
 void setSocketTimeout(int timeout)
           
 java.lang.String toString()
          

 

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

 

Field Detail

IDC_CONNECTION_KEY_PREFIX

public static final java.lang.String IDC_CONNECTION_KEY_PREFIX
See Also:
Constant Field Values

Constructor Detail

IdcConnection

public IdcConnection()
Default Constructor.

IdcConnection

public IdcConnection(javax.naming.Reference ref)
Constructor that takes in a jndi reference. The reference us used to initialize this object's properties.
Parameters:
ref - jndi reference the IdcConnection object will be created from.

Method Detail

getConnectionName

public java.lang.String getConnectionName()

setConnectionName

public void setConnectionName(java.lang.String connectionName)

create

public static IdcConnection create(javax.naming.Reference ref,
                                   javax.naming.Name name,
                                   javax.naming.Context nameCtx,
                                   java.util.Hashtable<?,?> environment)
Create an an IdcConnection from the given reference using the given name, context and environment properties.
Parameters:
ref - a jndi reference object.
name - jndi name.
nameCtx - jndi name context.
environment - environment property hashtable.
Returns:
an IdcConnection representation of the parameters.

getReference

public javax.naming.Reference getReference()
                                    throws javax.naming.NamingException
Specified by:
getReference in interface javax.naming.Referenceable
Returns:
Throws:
javax.naming.NamingException

isNewConnection

public boolean isNewConnection()
Is this a new connection or an already existing one?
Returns:
true if the connection already exists, false otherwise.

setConfigParameters

public void setConfigParameters(java.util.Map<java.lang.String,java.lang.String> configParams)
Set the configuration parameters of the IDC Connection.
Parameters:
configParams - a map containing configuration properties.

getConfigProperties

public java.util.Map<java.lang.String,java.lang.String> getConfigProperties()
Get the configuration properties of the IDC Connection.
Returns:
a map containing configuration properties as name value pair.

getProperty

public java.lang.String getProperty(java.lang.String name)
Retrieve a property value by name
Parameters:
name - the property name
Returns:
the value

setProperty

public void setProperty(java.lang.String name,
                        java.lang.String value)
Set a property name and value
Parameters:
name - the property name
value - the property value

getConnectionUrl

public java.lang.String getConnectionUrl()

setConnectionUrl

public void setConnectionUrl(java.lang.String connectionUrl)

getSocketTimeout

public int getSocketTimeout()

setSocketTimeout

public void setSocketTimeout(int timeout)

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object
Returns:

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

Skip navigation links

Oracle® Fusion Middleware Remote Intradoc Client (RIDC) Java API Reference
11g Release 1 (11.1.1)

E17274-01


Copyright © 2008, 2010, Oracle and/or its affiliates. All rights reserved.