MailSessionBinding (Oracle® Fusion Middleware Java API Reference for the Lifecycle Management Environment Specification)

java.lang.Object
- oracle.fmwplatform.envspec.model.topology.ServiceBinding
- - oracle.fmwplatform.envspec.model.topology.MailSessionBinding

All Implemented Interfaces:

oracle.fmwplatform.envspec.common.ContainerAware<Domain>, oracle.fmwplatform.envspec.common.Substitutable
```
public class MailSessionBinding
extends ServiceBinding
```
Binding to the MailSession and the service containing the mail session endpoints

Since:

12.2.2.0

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`PROP_DEFAULT_HOST`
`static String`	`PROP_DEFAULT_PASSWORD`
`static String`	`PROP_DEFAULT_PORT`
`static String`	`PROP_DEFAULT_USER`
`static String`	`PROP_PROTOCOL_HOST`
`static String`	`PROP_PROTOCOL_PASSWORD`
`static String`	`PROP_PROTOCOL_PORT`
`static String`	`PROP_PROTOCOL_USER`
`static String`	`PROP_STORE_TYPE`
`static String`	`PROP_TRANSPORT_TYPE`

Constructor Summary

Constructors
Constructor and Description

MailSessionBinding()

Constructors
Constructor and Description
`MailSessionBinding()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addCredentialRef(MailSessionCredential credential)`
`boolean`	`addJndiProperty(Property jndiProperty)` Add the additional property about the mail endpoint to the existing list of properties
`List<MailSessionCredential>`	`getCredentialRefs()`
`String`	`getDefaultCredentialRef()` Returns defaultCredentialRef
`List<Property>`	`getJndiProperties()` Return the additional set of properties for this mail endpoint
`static String`	`getProtocol(Pattern pattern, String matches)`
`String`	`getStoreProtocol()`
`String`	`getTransportProtocol()`
`static boolean`	`matches(Pattern pattern, String matches)`
`static boolean`	`matchesHost(String matches)`
`static boolean`	`matchesPassword(String matches)`
`static boolean`	`matchesPort(String matches)`
`static boolean`	`matchesUser(String matches)`
`static String`	`matchHostAndGetProtocol(String matches)`
`static String`	`matchPasswordAndGetProtocol(String matches)`
`static String`	`matchPortAndGetProtocol(String matches)`
`static String`	`matchUserAndGetProtocol(String matches)`
`MailSessionBinding`	`setCredentialRefs(List<MailSessionCredential> credentialRefs)`
`void`	`setDefaultCredentialRef(String defaultCredentialRef)` Set default credential
`MailSessionBinding`	`setJndiProperties(List<Property> jndiProperties)` Replace / set the additional mail endpoint properties
`MailSessionBinding`	`setResourceRef(String resourceRef)` Set the reference to the blueprint AppSvcResource
`MailSessionBinding`	`setServiceRef(Service serviceRef)` Set the reference to the service that contains the endpoints in the topology
`MailSessionBinding`	`setStoreProtocol(String storeProtocol)`
`MailSessionBinding`	`setTransportProtocol(String transportProtocol)`
`String`	`toCompactString()` Returns a compact string representation of the object in XML format.
`String`	`toJsonCompactString()` Returns a compact string representation of the object in JSON format.
`String`	`toJsonString()` Returns a string representation of the object in JSON format.
`String`	`toString()` Returns a string representation of the object in XML format.
`String`	`toXmlCompactString()` Returns a compact string representation of the object in XML format.
`String`	`toXmlString()` Returns a string representation of the object in XML format.

Methods inherited from class oracle.fmwplatform.envspec.model.topology.ServiceBinding
getParent, getResourceRef, getServiceRef, getVariableValue, setParent, substitute

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

- Field Detail
  - PROP_TRANSPORT_TYPE
```
public static final String PROP_TRANSPORT_TYPE
```
    See Also:
    
    Constant Field Values
  - PROP_STORE_TYPE
```
public static final String PROP_STORE_TYPE
```
    See Also:
    
    Constant Field Values
  - PROP_DEFAULT_USER
```
public static final String PROP_DEFAULT_USER
```
    See Also:
    
    Constant Field Values
  - PROP_DEFAULT_PASSWORD
```
public static final String PROP_DEFAULT_PASSWORD
```
    See Also:
    
    Constant Field Values
  - PROP_DEFAULT_HOST
```
public static final String PROP_DEFAULT_HOST
```
    See Also:
    
    Constant Field Values
  - PROP_DEFAULT_PORT
```
public static final String PROP_DEFAULT_PORT
```
    See Also:
    
    Constant Field Values
  - PROP_PROTOCOL_USER
```
public static final String PROP_PROTOCOL_USER
```
    See Also:
    
    Constant Field Values
  - PROP_PROTOCOL_PASSWORD
```
public static final String PROP_PROTOCOL_PASSWORD
```
    See Also:
    
    Constant Field Values
  - PROP_PROTOCOL_HOST
```
public static final String PROP_PROTOCOL_HOST
```
    See Also:
    
    Constant Field Values
  - PROP_PROTOCOL_PORT
```
public static final String PROP_PROTOCOL_PORT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MailSessionBinding
```
public MailSessionBinding()
```
- Method Detail
  - getTransportProtocol
```
public String getTransportProtocol()
```
  - setTransportProtocol
```
public MailSessionBinding setTransportProtocol(String transportProtocol)
```
  - getStoreProtocol
```
public String getStoreProtocol()
```
  - setStoreProtocol
```
public MailSessionBinding setStoreProtocol(String storeProtocol)
```
  - getCredentialRefs
```
public List<MailSessionCredential> getCredentialRefs()
```
  - getDefaultCredentialRef
```
public String getDefaultCredentialRef()
```
    Returns defaultCredentialRef
    
    Returns:
    
    defaultCredentialRef
  - setDefaultCredentialRef
```
public void setDefaultCredentialRef(String defaultCredentialRef)
```
    Set default credential
    
    Parameters:
    
    defaultCredentialRef - the default credential reference
  - setCredentialRefs
```
public MailSessionBinding setCredentialRefs(List<MailSessionCredential> credentialRefs)
```
  - addCredentialRef
```
public boolean addCredentialRef(MailSessionCredential credential)
```
  - setResourceRef
```
public MailSessionBinding setResourceRef(String resourceRef)
```
    Description copied from class: ServiceBinding
    
    Set the reference to the blueprint AppSvcResource
    
    Overrides:
    
    setResourceRef in class ServiceBinding
    
    Parameters:
    
    resourceRef - id of the resource
    
    Returns:
    
    ServiceBinding that contains this resource ref
  - setServiceRef
```
public MailSessionBinding setServiceRef(Service serviceRef)
```
    Description copied from class: ServiceBinding
    
    Set the reference to the service that contains the endpoints in the topology
    
    Overrides:
    
    setServiceRef in class ServiceBinding
    
    Parameters:
    
    serviceRef - id of the service
    
    Returns:
    
    ServiceBinding that contains this service
  - getJndiProperties
```
public List<Property> getJndiProperties()
```
    Return the additional set of properties for this mail endpoint
    
    Returns:
    
    property list
  - setJndiProperties
```
public MailSessionBinding setJndiProperties(List<Property> jndiProperties)
```
    Replace / set the additional mail endpoint properties
    
    Parameters:
    
    jndiProperties - for the mail endpoint
    
    Returns:
    
    MailSessionEndpoint that contains this list of properties
  - addJndiProperty
```
public boolean addJndiProperty(Property jndiProperty)
```
    Add the additional property about the mail endpoint to the existing list of properties
    
    Parameters:
    
    jndiProperty - property to add to the list
    
    Returns:
    
    true if the property did not exist in the list and was added to the properties
    
    Throws:
    
    IllegalArgumentException - if the property or the property name is null
  - matches
```
public static boolean matches(Pattern pattern,
                              String matches)
```
  - getProtocol
```
public static String getProtocol(Pattern pattern,
                                 String matches)
```
  - matchesHost
```
public static boolean matchesHost(String matches)
```
  - matchesPort
```
public static boolean matchesPort(String matches)
```
  - matchesUser
```
public static boolean matchesUser(String matches)
```
  - matchesPassword
```
public static boolean matchesPassword(String matches)
```
  - matchHostAndGetProtocol
```
public static String matchHostAndGetProtocol(String matches)
```
  - matchPortAndGetProtocol
```
public static String matchPortAndGetProtocol(String matches)
```
  - matchUserAndGetProtocol
```
public static String matchUserAndGetProtocol(String matches)
```
  - matchPasswordAndGetProtocol
```
public static String matchPasswordAndGetProtocol(String matches)
```
  - toXmlCompactString
```
public String toXmlCompactString()
```
    Returns a compact string representation of the object in XML format.
    
    Returns:
    
    a compact string representation of the object in XML format
  - toXmlString
```
public String toXmlString()
```
    Returns a string representation of the object in XML format.
    
    Returns:
    
    a string representation of the object in XML format
  - toJsonCompactString
```
public String toJsonCompactString()
```
    Returns a compact string representation of the object in JSON format.
    
    Returns:
    
    a compact string representation of the object in JSON format
  - toJsonString
```
public String toJsonString()
```
    Returns a string representation of the object in JSON format.
    
    Returns:
    
    a string representation of the object in JSON format
  - toCompactString
```
public String toCompactString()
```
    Returns a compact string representation of the object in XML format.
    
    Returns:
    
    a compact string representation of the object in XML format
  - toString
```
public String toString()
```
    Returns a string representation of the object in XML format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of the object in XML format

Class MailSessionBinding

Field Summary

Constructor Summary

Method Summary

Methods inherited from class oracle.fmwplatform.envspec.model.topology.ServiceBinding

Methods inherited from class java.lang.Object

Field Detail

PROP_TRANSPORT_TYPE

PROP_STORE_TYPE

PROP_DEFAULT_USER

PROP_DEFAULT_PASSWORD

PROP_DEFAULT_HOST

PROP_DEFAULT_PORT

PROP_PROTOCOL_USER

PROP_PROTOCOL_PASSWORD

PROP_PROTOCOL_HOST

PROP_PROTOCOL_PORT

Constructor Detail

MailSessionBinding

Method Detail

getTransportProtocol

setTransportProtocol

getStoreProtocol

setStoreProtocol

getCredentialRefs

getDefaultCredentialRef

setDefaultCredentialRef

setCredentialRefs

addCredentialRef

setResourceRef

setServiceRef

getJndiProperties

setJndiProperties

addJndiProperty

matches

getProtocol

matchesHost

matchesPort

matchesUser

matchesPassword

matchHostAndGetProtocol

matchPortAndGetProtocol

matchUserAndGetProtocol

matchPasswordAndGetProtocol

toXmlCompactString

toXmlString

toJsonCompactString

toJsonString

toCompactString

toString