TIF ENOVIA/3DExperience Connector - Configurable REST Services

public class MyContextProviderHandler implements ContextProviderHandler {

    @Override
    public ContextProvider apply(AuthorizationContext ctx, CredentialsConfig config) {
        // Principal available in case container-managed-security is enabled. Otherwise, null.
        Principal p = ctx.getPrincipal();

        // EXAMPLE: Use the ENOVIA user credentials directly.
        if (principal instanceof EnoviaUserPrincipal) {
            EnoviaUserPrincipal eup = (EnoviaUserPrincipal) principal;
            if (eup.isValid()) {
                return eup;
            }
        }

        // EXAMPLE: Get headers
        List<String> headerNames = ctx.getHeaderNames();
        for (String header : headerNames) {
            System.out.printf("Header>>> %30s : %s%n", header, ctx.getHeaderValues(header));
        }

        // EXAMPLE: Get parameters
        List<String> paramNames = ctx.getParameterNames();
        for (String param : paramNames) {
            System.out.printf("Parameter>>> %30s : %s%n", param,
                    StringUtils.concat(ctx.getParameterValues(param), "|"));
        }

        // EXAMPLE: Get other request based properties
        if (ctx instanceof RequestBasedAuthorizationContext) {
            RequestBasedAuthorizationContext rctx = (RequestBasedAuthorizationContext) ctx;
            System.out.printf("Request URI>> %s%n", rctx.getHttpServletRequest().getRequestURI());
        }

        // EXAMPLE: Run as specific user
        String runAs = ctx.getHeaderValue("x-run-as");
        return ContextProviders.getRunAs(runAs);
    }
}

import com.technia.tif.enovia.security.DefaultContextProviderHandler;

// ...
ContextProvider contextProvider = ...;
return DefaultContextProviderHandler.getInstance().apply(ctx, credentials, contextProvider);

import com.technia.tif.enovia.jaxrs.RESTException;

// Respond with a status code "401 Unauthorized" and include a JSON messge.
String jsonMessage = "...";
throw new RESTException(401, jsonMessage, "application/json");

<SecurityContext mapFile="sec-mapping.xml" />

<SecurityContext useDefaultMapFile="true" />

<Contexts>
    <Context name="Design Engineer.Company Name.GLOBAL">
        <User is="user1" />(1)
        <User is="user2" />
        <User is="user3" />

        <Role is="engineer" /> (2)
        <Role is="designer" />

        <Parameter name="test" is="something" /> (3)
        <Parameter name="x" is="y" />
    </Context>
    <Context name="...">...</Context>
    <Context name="...">...</Context>
</Contexts>

<SecurityContext use="Design Engineer.Company Name.GLOBAL" />

<SecurityContext useDefault="true" />

<security-constraint>
    <web-resource-collection>
        <web-resource-name>blocked</web-resource-name>
        <url-pattern>/service/*</url-pattern>
    </web-resource-collection>
    <auth-constraint>
        <role-name>WS-Integration-User</role-name>
    </auth-constraint>
    <user-data-constraint>
        <transport-guarantee>NONE</transport-guarantee>
    </user-data-constraint>
</security-constraint>
<login-config>
    <auth-method>BASIC</auth-method>
    <realm-name>Webservices</realm-name>
</login-config>

<security-constraint>
    <web-resource-collection>
        <web-resource-name>blocked</web-resource-name>
        <url-pattern>/service/*</url-pattern>
    </web-resource-collection>
</security-constraint>
<login-config>
    <auth-method>BEARER</auth-method>
    <realm-name>Webservices</realm-name>
</login-config>

<security-constraint>
    <web-resource-collection>
        <web-resource-name>blocked</web-resource-name>
        <url-pattern>/service/*</url-pattern>
    </web-resource-collection>
    <auth-constraint>
        <role-name>EXAMPLEDOMAIN.COM</role-name>
    </auth-constraint>
</security-constraint>
<login-config>
    <auth-method>SPNEGO</auth-method>
    <realm-name>Webservices</realm-name>
</login-config>

<IdLocator type="tnr">
    <AllowWildcards>false</AllowWildcards>
    <IfNotFound statusCode="200" contentType="application/json">
        {
            "error_code": "E0003",
            "reason": "Object not found"
        }
    </IfNotFound>
</IdLocator>

<IdLocator type="tnr">
    <AllowWildcards>false</AllowWildcards>

    <Condition expression="description == 'foo'" evaluatesTo="true" ignoreCase="true">
        <IfNotMatched contentType="application/json" statusCode="234">
            {
                "error": "E2322"
            }
        </IfNotMatched>
    </Condition>

    <Condition expression="current == Obsolete" evaluatesTo="false">
        <IfNotMatched response="BAD STATUS" statusCode="454" />
    </Condition>

    <IfNotFound statusCode="200" contentType="application/json">
        {
            "error_code": "E0003",
            "reason": "Object not found"
        }
    </IfNotFound>
</IdLocator>

<Rest>
    <ServiceName>product</ServiceName>
    <IdLocator dataset="tvc:data/ProductInStateFinder.xml" />
    ...
</Rest>

<DataSet>
    <LatestInState>
        <State>$(pathparam_1,empty=false)</State>
        <Query>
            <NamePattern>
                <Name>$(pathparam_0,empty=false)</Name>
            </NamePattern>
            <Limit>1</Limit>
        </Query>
    </LatestInState>
</DataSet>

<Rest>
    <ServiceName>product</ServiceName>
    <IdLocator type="tnr">
        <Where>revision==last"</Where>
        <Limit>1</Limit>
    </IdLocator>
    ...
</Rest>

<Rest>
    <ServiceName>product</ServiceName>
    <IdLocator type="value">
        <Match>$&lt;attribute[attribute_ProductId]&gt;</Match>
    </IdLocator>
    ...
</Rest>

http://server-name:8181/enovia/jaxrs/service/product/9857847

<Rest>
    <ServiceName>product</ServiceName>
    <IdLocator type="objectid" />
    ...
</Rest>

http://server-name:8181/enovia/jaxrs/service/product/1234.5678.9123.4567

/**
 * Responsible for identifying objects requested by the client of a configurable
 * REST web service.
 *
 * @since 2015.3.0
 */
public interface IdLocator {

    /**
     * Locates object id/s based on the provided input.
     *
     * @param ctx Information about this REST call
     * @return The object id/s
     * @throws IdLocatorException Thrown if problem occur. For example, if no
     *         object was found.
     * @since 2015.3.0
     */
    Collection<String> locateIds(ExecutionCtx ctx) throws IdLocatorException;
}

<Job>
    <Name>The name of the async job</Name>
    <CreateUpdate config="tvc:createconfig/MyConfig.xml" />
</Job>