Skip navigation links

Oracle® WebCenter Content Java API Reference for Imaging
11g Release 1 (11.1.1)

E12853-03


oracle.imaging
Class Connection

java.lang.Object
  extended by oracle.imaging.BaseId
      extended by oracle.imaging.Definition
          extended by oracle.imaging.Connection


public class Connection
extends Definition

Nested Class Summary
static class Connection.Ability
          Enumeration validating that the current user has this ability on the Connections.
static class Connection.ConnectionType
          Enumeration listing out the different possible types of connections that are available.
static class Connection.Details
           
static class Connection.Properties
           
static class Connection.SectionFlag
          Flags that identify which sections are applicable to a specific request.
static class Connection.SectionSet
           

 

Nested classes/interfaces inherited from class oracle.imaging.Definition
Definition.DefinitionPk, Definition.Permissions, Definition.SectionPk, Definition.Security, Definition.SequencePk

 

Field Summary
static java.lang.String CONNECTION_REPOSITORY_ADMIN_KEY
          Deprecated. This key is no longer necessary as the connection admin is now a predefined value.
static java.lang.String CONNECTION_REPOSITORY_KEYSTORE_ALIAS_KEY
          The key value for the Connection use key alias csf key property
static java.lang.String CONNECTION_REPOSITORY_MACHINE_KEY
          The key value for the Connection machine name
static java.lang.String CONNECTION_REPOSITORY_PORT_KEY
          The key value for the Connection port
static java.lang.String CONNECTION_REPOSITORY_SECONDARIES_KEY
          The key value for the Connection secondary addresses
static java.lang.String CONNECTION_REPOSITORY_TYPE_KEY
          The key value for the Repository Type
static java.lang.String CONNECTION_REPOSITORY_TYPE_UCM
          The value for the Repository Type UCM
static java.lang.String CONNECTION_REPOSITORY_USESSL_KEY
          The key value for the Connection use SSL property
static java.lang.String CONNECTION_UPDATED_SYSTEM_GUID_KEY
          The key value for whether the Repository has been updated with the system GUID.
static java.lang.String CONNECTION_WORKFLOW_CSFKEY_KEY
          The key value for the Connection port
static java.lang.String CONNECTION_WORKFLOW_FRONT_ADDR
          The key value for the Workflow server's JNDI provider address
static java.lang.String CONNECTION_WORKFLOW_MACHINE_KEY
          Deprecated. This key is no longer used see the provider and front end address keys
static java.lang.String CONNECTION_WORKFLOW_PORT_KEY
          Deprecated. This key is no longer used see the provider and front end address keys
static java.lang.String CONNECTION_WORKFLOW_PROVIDER
          The key value for the Workflow server front end address.
static java.lang.String CONNECTION_WORKFLOW_SSLPORT_KEY
          Deprecated. This key is no longer used see the provider and front end address keys
protected  Definition.Permissions permissions
           
protected  java.util.List<Definition.Security> security
           

 

Fields inherited from class oracle.imaging.Definition
description, id, name, version

 

Fields inherited from class oracle.imaging.BaseId
ID_COMPARATOR, NAME_COMPARATOR

 

Constructor Summary
Connection()
           
Connection(long l)
           
Connection(long l, java.lang.String string)
           
Connection(java.lang.String string)
           

 

Method Summary
 java.lang.String findDetailValue(java.lang.String detailKey)
          Searches the connection detailsList list for the given detailKey and returns the matching detailValue if it exists.
 Connection.Details getDetails()
          Retrieves the set of connection detail items from the Connection
 java.util.List<AuditEvent> getHistory()
          Gets the History section property.
 Definition.Permissions getPermissions()
          Gets the Permissions section property.
 Connection.Properties getProperties()
          Fetches the connection properties for the Connection object.
 java.util.List<Definition.Security> getSecurity()
          Gets the Security section property.
protected  void postLoad()
           
protected  void prePersist()
           
 void setDetails(Connection.Details details)
          Saves a set of connection information to the Connection definition.
 void setHistory(java.util.List<AuditEvent> history)
          Sets the History section property.
 void setPermissions(Definition.Permissions permissions)
          A convenience method for JAXB and Imaging services.
 void setProperties(Connection.Properties connectionProperties)
          Applies a new properties object to the connection.
 void setSecurity(java.util.List<Definition.Security> security)
          Sets the Security section property.
 java.lang.String toString()
           

 

Methods inherited from class oracle.imaging.Definition
getAvailablePermissions, getDefinitionSecurityArea, getDefinitionTypeName, getDescription, getId, getName, setDescription, setId, setName

 

Methods inherited from class oracle.imaging.BaseId
equals, hashCode, nameTrimOrNull, toNameId

 

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

 

Field Detail

CONNECTION_REPOSITORY_TYPE_KEY

public static final java.lang.String CONNECTION_REPOSITORY_TYPE_KEY
The key value for the Repository Type
See Also:
Constant Field Values

CONNECTION_REPOSITORY_TYPE_UCM

public static final java.lang.String CONNECTION_REPOSITORY_TYPE_UCM
The value for the Repository Type UCM
See Also:
Constant Field Values

CONNECTION_REPOSITORY_MACHINE_KEY

public static final java.lang.String CONNECTION_REPOSITORY_MACHINE_KEY
The key value for the Connection machine name
See Also:
Constant Field Values

CONNECTION_REPOSITORY_PORT_KEY

public static final java.lang.String CONNECTION_REPOSITORY_PORT_KEY
The key value for the Connection port
See Also:
Constant Field Values

CONNECTION_REPOSITORY_USESSL_KEY

public static final java.lang.String CONNECTION_REPOSITORY_USESSL_KEY
The key value for the Connection use SSL property
See Also:
Constant Field Values

CONNECTION_REPOSITORY_KEYSTORE_ALIAS_KEY

public static final java.lang.String CONNECTION_REPOSITORY_KEYSTORE_ALIAS_KEY
The key value for the Connection use key alias csf key property
See Also:
Constant Field Values

CONNECTION_UPDATED_SYSTEM_GUID_KEY

public static final java.lang.String CONNECTION_UPDATED_SYSTEM_GUID_KEY
The key value for whether the Repository has been updated with the system GUID.
See Also:
Constant Field Values

CONNECTION_REPOSITORY_ADMIN_KEY

@Deprecated
public static final java.lang.String CONNECTION_REPOSITORY_ADMIN_KEY
Deprecated. This key is no longer necessary as the connection admin is now a predefined value.
The key value for the Connection admin name
See Also:
Constant Field Values

CONNECTION_REPOSITORY_SECONDARIES_KEY

public static final java.lang.String CONNECTION_REPOSITORY_SECONDARIES_KEY
The key value for the Connection secondary addresses
See Also:
Constant Field Values

CONNECTION_WORKFLOW_MACHINE_KEY

@Deprecated
public static final java.lang.String CONNECTION_WORKFLOW_MACHINE_KEY
Deprecated. This key is no longer used see the provider and front end address keys
The key value for the Connection machine name
See Also:
Constant Field Values

CONNECTION_WORKFLOW_PORT_KEY

@Deprecated
public static final java.lang.String CONNECTION_WORKFLOW_PORT_KEY
Deprecated. This key is no longer used see the provider and front end address keys
The key value for the Connection port
See Also:
Constant Field Values

CONNECTION_WORKFLOW_SSLPORT_KEY

@Deprecated
public static final java.lang.String CONNECTION_WORKFLOW_SSLPORT_KEY
Deprecated. This key is no longer used see the provider and front end address keys
The key value for the Connection SSL port
See Also:
Constant Field Values

CONNECTION_WORKFLOW_CSFKEY_KEY

public static final java.lang.String CONNECTION_WORKFLOW_CSFKEY_KEY
The key value for the Connection port
See Also:
Constant Field Values

CONNECTION_WORKFLOW_PROVIDER

public static final java.lang.String CONNECTION_WORKFLOW_PROVIDER
The key value for the Workflow server front end address. the value should include the listeneing port.
See Also:
Constant Field Values

CONNECTION_WORKFLOW_FRONT_ADDR

public static final java.lang.String CONNECTION_WORKFLOW_FRONT_ADDR
The key value for the Workflow server's JNDI provider address
See Also:
Constant Field Values

permissions

protected Definition.Permissions permissions

security

protected java.util.List<Definition.Security> security

Constructor Detail

Connection

public Connection(java.lang.String string)

Connection

public Connection(long l)

Connection

public Connection(long l,
                  java.lang.String string)

Connection

public Connection()

Method Detail

prePersist

protected void prePersist()

postLoad

protected void postLoad()

toString

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

getSecurity

public java.util.List<Definition.Security> getSecurity()
Gets the Security section property.
Specified by:
getSecurity in class Definition
Returns:
The Security section property value

setSecurity

public void setSecurity(java.util.List<Definition.Security> security)
Sets the Security section property.
Specified by:
setSecurity in class Definition
Parameters:
security - The new Security section property value

getPermissions

public Definition.Permissions getPermissions()
Gets the Permissions section property.
Specified by:
getPermissions in class Definition
Returns:
The Permissions section property value

setPermissions

public void setPermissions(Definition.Permissions permissions)
A convenience method for JAXB and Imaging services. Calling this method to set permissions will have no affect. Instead, use the ConnectionService.createConnection or ConnectionService.modifyConnection services, using the Connection.SectionFlag.SECURITY section to change the security member permissions to a Connection.
Specified by:
setPermissions in class Definition
Parameters:
permissions - the permissions set by JAXB or Imaging services

getHistory

public java.util.List<AuditEvent> getHistory()
Gets the History section property.
Specified by:
getHistory in class Definition
Returns:
The History section property value

setHistory

public void setHistory(java.util.List<AuditEvent> history)
Sets the History section property.
Specified by:
setHistory in class Definition
Parameters:
history - A new History section property value

setProperties

public void setProperties(Connection.Properties connectionProperties)
Applies a new properties object to the connection.
Parameters:
connectionProperties - The new connection properites to save.

getProperties

public Connection.Properties getProperties()
Fetches the connection properties for the Connection object.
Returns:
The Connection Properties

setDetails

public void setDetails(Connection.Details details)
Saves a set of connection information to the Connection definition.
Parameters:
details - The new set of detailsList to save.

getDetails

public Connection.Details getDetails()
Retrieves the set of connection detail items from the Connection
Returns:
The information associated with the Connection

findDetailValue

public java.lang.String findDetailValue(java.lang.String detailKey)
Searches the connection detailsList list for the given detailKey and returns the matching detailValue if it exists. If the detail cannot be found then null is returned.
Parameters:
detailKey - The detail detailKey to search for
Returns:
The connection detailValue matching the detailKey or null if not found

Skip navigation links

Oracle® WebCenter Content Java API Reference for Imaging
11g Release 1 (11.1.1)

E12853-03


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