package org.jboss.windup.rules.apps.javaee.model;
import org.jboss.windup.graph.Indexed;
import org.jboss.windup.graph.model.WindupVertexFrame;
import com.tinkerpop.frames.Property;
import com.tinkerpop.frames.modules.typedgraph.TypeValue;
import org.jboss.windup.rules.apps.java.model.mixin.HasTypeModel;
/**
* Represents an <resource-ref> entry from a Java deployment descriptor (eg, web.xml).
*
<pre>
<![CDATA[
<web-app>
<description>MySQL Test App</description>
<resource-ref>
<description>DB Connection</description>
<res-ref-name>jdbc/TestDB</res-ref-name>
<res-type>javax.sql.DataSource</res-type>
<res-auth>Container</res-auth>
</resource-ref>
</web-app>
<Resource name="jdbc/TestDB" auth="Container" type="javax.sql.DataSource"
maxTotal="100" maxIdle="30" maxWaitMillis="10000"
username="javauser" password="javadude" driverClassName="com.mysql.jdbc.Driver"
url="jdbc:mysql://localhost:3306/javatest"/>
]]></pre>
*
* @author <a href="mailto:zizka@seznam.cz">Ondrej Zizka</a>
*/
@TypeValue(WebXmlResourceReferenceModel.TYPE)
public interface WebXmlResourceReferenceModel extends WindupVertexFrame, HasTypeModel
{
public static final String TYPE = "WebXmlResourceReference";
public static final String RESOURCE_NAME = "resourceName";
public static final String RESOURCE_AUTH = "resourceAuth";
public static final String DESCRIPTION = "desc";
/**
* Contains the reference id
*/
@Indexed
@Property(RESOURCE_NAME)
public String getReferenceName();
/**
* Contains the reference id
*/
@Property(RESOURCE_NAME)
public void setReferenceName(String resourceId);
/**
* The referenced resource's auth (res-auth).
*/
@Property(RESOURCE_AUTH)
public String getResourceAuth();
/**
* The referenced resource's auth (res-auth).
*/
@Property(RESOURCE_AUTH)
public void setResourceAuth(String auth);
/**
* Resource description
*/
@Property(DESCRIPTION)
public String getDescription();
/**
* Resource description
*/
@Property(DESCRIPTION)
public void setDescription(String desc);
}