org.eclipse.modisco.jee.ejbjar.EjbJar30
Interface InterceptorBindingType


public interface InterceptorBindingType

A representation of the model object 'Interceptor Binding Type'. The interceptor-bindingType element describes the binding of interceptor classes to beans within the ejb-jar. It consists of : - An optional description. - The name of an ejb within the ejb-jar or the wildcard value "*", which is used to define interceptors that are bound to all beans in the ejb-jar. - A list of interceptor classes that are bound to the contents of the ejb-name element or a specification of the total ordering over the interceptors defined for the given level and above. - An optional exclude-default-interceptors element. If set to true, specifies that default interceptors are not to be applied to a bean-class and/or business method. - An optional exclude-class-interceptors element. If set to true, specifies that class interceptors are not to be applied to a business method. - An optional set of method elements for describing the name/params of a method-level interceptor. Interceptors bound to all classes using the wildcard syntax "*" are default interceptors for the components in the ejb-jar. In addition, interceptors may be bound at the level of the bean class (class-level interceptors) or business methods (method-level interceptors ). The binding of interceptors to classes is additive. If interceptors are bound at the class-level and/or default-level as well as the method-level, both class-level and/or default-level as well as method-level will apply. There are four possible styles of the interceptor element syntax : 1. * INTERCEPTOR Specifying the ejb-name as the wildcard value "*" designates default interceptors (interceptors that apply to all session and message-driven beans contained in the ejb-jar). 2. EJBNAME INTERCEPTOR This style is used to refer to interceptors associated with the specified enterprise bean(class-level interceptors). 3. EJBNAME INTERCEPTOR METHOD This style is used to associate a method-level interceptor with the specified enterprise bean. If there are multiple methods with the same overloaded name, the element of this style refers to all the methods with the overloaded name. Method-level interceptors can only be associated with business methods of the bean class. Note that the wildcard value "*" cannot be used to specify method-level interceptors. 4. EJBNAME INTERCEPTOR METHOD PARAM-1 PARAM-2 ... PARAM-N This style is used to associate a method-level interceptor with the specified method of the specified enterprise bean. This style is used to refer to a single method within a set of methods with an overloaded name. The values PARAM-1 through PARAM-N are the fully-qualified Java types of the method's input parameters (if the method has no input arguments, the method-params element contains no method-param elements). Arrays are specified by the array element's type, followed by one or more pair of square brackets (e.g. int[][]).

The following features are supported:

See Also:
EjbJar30Package.getInterceptorBindingType()
Generated:
Model:
extendedMetaData="name='interceptor-bindingType' kind='elementOnly'"

Method Summary
  getDescription()
          Returns the value of the 'Description' containment reference list.
 String getEjbName()
          Returns the value of the 'Ejb Name' containment reference.
 TrueFalseType getExcludeClassInterceptors()
          Returns the value of the 'Exclude Class Interceptors' containment reference.
 TrueFalseType getExcludeDefaultInterceptors()
          Returns the value of the 'Exclude Default Interceptors' containment reference.
 java.lang.String getId()
          Returns the value of the 'Id' attribute.
  getInterceptorClass()
          Returns the value of the 'Interceptor Class' containment reference list.
 InterceptorOrderType getInterceptorOrder()
          Returns the value of the 'Interceptor Order' containment reference.
 NamedMethodType getMethod()
          Returns the value of the 'Method' containment reference.
 void setEjbName(String value)
          Sets the value of the 'Ejb Name' containment reference.
 void setExcludeClassInterceptors(TrueFalseType value)
          Sets the value of the 'Exclude Class Interceptors' containment reference.
 void setExcludeDefaultInterceptors(TrueFalseType value)
          Sets the value of the 'Exclude Default Interceptors' containment reference.
 void setId(java.lang.String value)
          Sets the value of the 'Id' attribute.
 void setInterceptorOrder(InterceptorOrderType value)
          Sets the value of the 'Interceptor Order' containment reference.
 void setMethod(NamedMethodType value)
          Sets the value of the 'Method' containment reference.
 

Method Detail

getDescription

 getDescription()
Returns the value of the 'Description' containment reference list. The list contents are of type DescriptionType.

If the meaning of the 'Description' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Description' containment reference list.
See Also:
EjbJar30Package.getInterceptorBindingType_Description()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='description' namespace='http://java.sun.com/xml/ns/javaee'"

getEjbName

String getEjbName()
Returns the value of the 'Ejb Name' containment reference.

If the meaning of the 'Ejb Name' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Ejb Name' containment reference.
See Also:
setEjbName(org.eclipse.modisco.jee.ejbjar.EjbJar30.String), EjbJar30Package.getInterceptorBindingType_EjbName()
Generated:
Model:
containment="true" required="true" extendedMetaData="kind='element' name='ejb-name' namespace='http://java.sun.com/xml/ns/javaee'"

setEjbName

void setEjbName(String value)
Sets the value of the 'Ejb Name' containment reference.

Parameters:
value - the new value of the 'Ejb Name' containment reference.
See Also:
getEjbName()
Generated:

getInterceptorClass

 getInterceptorClass()
Returns the value of the 'Interceptor Class' containment reference list. The list contents are of type FullyQualifiedClassType.

If the meaning of the 'Interceptor Class' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Interceptor Class' containment reference list.
See Also:
EjbJar30Package.getInterceptorBindingType_InterceptorClass()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='interceptor-class' namespace='http://java.sun.com/xml/ns/javaee'"

getInterceptorOrder

InterceptorOrderType getInterceptorOrder()
Returns the value of the 'Interceptor Order' containment reference.

If the meaning of the 'Interceptor Order' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Interceptor Order' containment reference.
See Also:
setInterceptorOrder(InterceptorOrderType), EjbJar30Package.getInterceptorBindingType_InterceptorOrder()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='interceptor-order' namespace='http://java.sun.com/xml/ns/javaee'"

setInterceptorOrder

void setInterceptorOrder(InterceptorOrderType value)
Sets the value of the 'Interceptor Order' containment reference.

Parameters:
value - the new value of the 'Interceptor Order' containment reference.
See Also:
getInterceptorOrder()
Generated:

getExcludeDefaultInterceptors

TrueFalseType getExcludeDefaultInterceptors()
Returns the value of the 'Exclude Default Interceptors' containment reference.

If the meaning of the 'Exclude Default Interceptors' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Exclude Default Interceptors' containment reference.
See Also:
setExcludeDefaultInterceptors(TrueFalseType), EjbJar30Package.getInterceptorBindingType_ExcludeDefaultInterceptors()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='exclude-default-interceptors' namespace='http://java.sun.com/xml/ns/javaee'"

setExcludeDefaultInterceptors

void setExcludeDefaultInterceptors(TrueFalseType value)
Sets the value of the 'Exclude Default Interceptors' containment reference.

Parameters:
value - the new value of the 'Exclude Default Interceptors' containment reference.
See Also:
getExcludeDefaultInterceptors()
Generated:

getExcludeClassInterceptors

TrueFalseType getExcludeClassInterceptors()
Returns the value of the 'Exclude Class Interceptors' containment reference.

If the meaning of the 'Exclude Class Interceptors' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Exclude Class Interceptors' containment reference.
See Also:
setExcludeClassInterceptors(TrueFalseType), EjbJar30Package.getInterceptorBindingType_ExcludeClassInterceptors()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='exclude-class-interceptors' namespace='http://java.sun.com/xml/ns/javaee'"

setExcludeClassInterceptors

void setExcludeClassInterceptors(TrueFalseType value)
Sets the value of the 'Exclude Class Interceptors' containment reference.

Parameters:
value - the new value of the 'Exclude Class Interceptors' containment reference.
See Also:
getExcludeClassInterceptors()
Generated:

getMethod

NamedMethodType getMethod()
Returns the value of the 'Method' containment reference.

If the meaning of the 'Method' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Method' containment reference.
See Also:
setMethod(NamedMethodType), EjbJar30Package.getInterceptorBindingType_Method()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='method' namespace='http://java.sun.com/xml/ns/javaee'"

setMethod

void setMethod(NamedMethodType value)
Sets the value of the 'Method' containment reference.

Parameters:
value - the new value of the 'Method' containment reference.
See Also:
getMethod()
Generated:

getId

java.lang.String getId()
Returns the value of the 'Id' attribute.

If the meaning of the 'Id' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Id' attribute.
See Also:
setId(String), EjbJar30Package.getInterceptorBindingType_Id()
Generated:
Model:
id="true" dataType="org.eclipse.emf.ecore.xml.type.ID" extendedMetaData="kind='attribute' name='id'"

setId

void setId(java.lang.String value)
Sets the value of the 'Id' attribute.

Parameters:
value - the new value of the 'Id' attribute.
See Also:
getId()
Generated: