{"type":"doc","content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"f837bcf6-b855-47c2-91cc-953a6e4e00c7"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"7f1f449f-8c7e-4cc7-9f7d-82e093d19022"}},{"type":"heading","attrs":{"level":2},"content":[{"text":"Overview","type":"text"}]},{"type":"paragraph","content":[{"text":"bla bla bla","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Implement the function","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Data Connectors","type":"text"}]},{"type":"paragraph","content":[{"text":"Extend ","type":"text"},{"text":"AbstractDataConnector","type":"text","marks":[{"type":"link","attrs":{"href":"http://shibboleth.net/cgi-bin/java-attribute.cgi/net.shibboleth.idp.attribute.resolver.AbstractDataConnector"}}]},{"text":" and implement:","type":"text"}]},{"type":"table","attrs":{"layout":"wide","width":960.0,"localId":"258d5bf3-ac8c-4c9c-9c6d-038e4276418a"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"Method","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[71.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[709.0]},"content":[{"type":"paragraph","content":[{"text":"Purpose","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"doDataConnectorResolve","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[71.0]},"content":[{"type":"paragraph","content":[{"text":"Yes","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[709.0]},"content":[{"type":"paragraph","content":[{"text":"Return a newly created and fully populated Map","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"doInitialize","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[71.0]},"content":[{"type":"paragraph","content":[{"text":"No","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[709.0]},"content":[{"type":"paragraph","content":[{"text":"To check any preconditions before the resolver is first used","type":"text"}]},{"type":"paragraph","content":[{"text":"Ensure that there is a call to ","type":"text"},{"text":"super.doInitialize()","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[180.0]},"content":[{"type":"paragraph","content":[{"text":"doDestroy","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[71.0]},"content":[{"type":"paragraph","content":[{"text":"No","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[709.0]},"content":[{"type":"paragraph","content":[{"text":"To tear down any structures when the Data Connector is finished with (due to shutdown or reload)","type":"text"}]},{"type":"paragraph","content":[{"text":"Ensure that there is a call to ","type":"text"},{"text":"super.doDestroy()","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"The above are the methods you are most likely to implement. There are others, consult the javadoc for the Abstract Class and its parent classes for more details.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Attribute Definitions","type":"text"}]},{"type":"paragraph","content":[{"text":"Extend ","type":"text"},{"text":"AbstractAttributeDefinition","type":"text","marks":[{"type":"link","attrs":{"href":"http://shibboleth.net/cgi-bin/java-attribute.cgi/net.shibboleth.idp.attribute.resolver.AbstractAttributeDefinition"}}]},{"text":" and implement:","type":"text"}]},{"type":"table","attrs":{"layout":"full-width","width":1800.0,"localId":"aae0ce3e-7ce5-470c-9b50-1343faf981c6"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[356.0]},"content":[{"type":"paragraph","content":[{"text":"Method","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[112.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[1129.0]},"content":[{"type":"paragraph","content":[{"text":"Purpose","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[356.0]},"content":[{"type":"paragraph","content":[{"text":"doAttributeDefinitionResolve","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[112.0]},"content":[{"type":"paragraph","content":[{"text":"Yes","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1129.0]},"content":[{"type":"paragraph","content":[{"text":"Return a newly created and fully populated ","type":"text"},{"text":"IdPAttribute","type":"text","marks":[{"type":"link","attrs":{"href":"http://shibboleth.net/cgi-bin/java-attribute.cgi/net.shibboleth.idp.attribute.IdPAttribute"}}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[356.0]},"content":[{"type":"paragraph","content":[{"text":"doInitialize","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[112.0]},"content":[{"type":"paragraph","content":[{"text":"No","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1129.0]},"content":[{"type":"paragraph","content":[{"text":"To check any preconditions before the resolver is first used.","type":"text"}]},{"type":"paragraph","content":[{"text":"Ensure that there is a call to ","type":"text"},{"text":"super.doInitialize()","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[356.0]},"content":[{"type":"paragraph","content":[{"text":"doDestroy","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[112.0]},"content":[{"type":"paragraph","content":[{"text":"No","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1129.0]},"content":[{"type":"paragraph","content":[{"text":"To tear down any structures when the resolver is finished with (due to shutdown or reload)","type":"text"}]},{"type":"paragraph","content":[{"text":"Ensure that there is a call to ","type":"text"},{"text":"super.doDestroy()","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"The above are the methods you are most likely to implement. There are others, consult the Javadoc for the abstract Class and its parent classes for more details.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Parsers","type":"text"}]},{"type":"paragraph","content":[{"text":"In order to write a parser you must first devise the schema to describe the plugin. This schema should","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Be made available to the IdP in the src\\main\\resources\\schema directory of your project","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Be available at an http: location","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"But also have a mapping available in the src\\main\\resources\\META-INF\\spring.schemas directory of your project.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"(optionally) be overridden in eclipse.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"After which bla bla bla","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Do I need a Factory Bean?","type":"text"}]},{"type":"paragraph","content":[{"text":"See ","type":"text"},{"text":"this discussion","type":"text","marks":[{"type":"link","attrs":{"href":"https://shibboleth.atlassian.net/wiki/spaces/IDP4/pages/1265631885"}}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Data Connector Parsers","type":"text"}]},{"type":"paragraph","content":[{"text":"Extend ","type":"text"},{"text":"AbstractDataConnectorParser","type":"text","marks":[{"type":"link","attrs":{"href":"http://shibboleth.net/cgi-bin/java-attribute.cgi/net.shibboleth.idp.attribute.resolver.spring.dc.AbstractDataConnectorParser"}}]},{"text":" and implement:","type":"text"}]},{"type":"table","attrs":{"layout":"wide","width":960.0,"localId":"e929ac32-6c34-418c-8a50-3c4f152dc866"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[169.0]},"content":[{"type":"paragraph","content":[{"text":"Method","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[81.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[710.0]},"content":[{"type":"paragraph","content":[{"text":"Purpose","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[169.0]},"content":[{"type":"paragraph","content":[{"text":"getNativeBeanClass","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[81.0]},"content":[{"type":"paragraph","content":[{"text":"Yes","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[710.0]},"content":[{"type":"paragraph","content":[{"text":"Return the class that your Data Connector Implements (or an appropriate Factory Bean)","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[169.0]},"content":[{"type":"paragraph","content":[{"text":"doV2Parse","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[81.0]},"content":[{"type":"paragraph","content":[{"text":"Yes","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[710.0]},"content":[{"type":"paragraph","content":[{"text":"To parse your native Schema and populate the Data Connector or its Factory Bean","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":" The above are the methods you have to implement. There are others, consult the Javadoc for the abstract class and its parent classes for more details.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Attribute Definition Parsers","type":"text"}]},{"type":"paragraph","content":[{"text":"Extend ","type":"text"},{"text":"BaseAttributeDefinitionParser","type":"text","marks":[{"type":"link","attrs":{"href":"http://shibboleth.net/cgi-bin/java-attribute.cgi/net.shibboleth.idp.attribute.resolver.spring.ad.BaseAttributeDefinitionParser"}}]},{"text":" and implement:","type":"text"}]},{"type":"table","attrs":{"layout":"wide","width":960.0,"localId":"7870d323-df78-4ace-ab7d-d5bb9a5eb44c"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[102.0]},"content":[{"type":"paragraph","content":[{"text":"Method","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[72.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[786.0]},"content":[{"type":"paragraph","content":[{"text":"Purpose","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[102.0]},"content":[{"type":"paragraph","content":[{"text":"getBeanClass","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[72.0]},"content":[{"type":"paragraph","content":[{"text":"Yes","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[786.0]},"content":[{"type":"paragraph","content":[{"text":"Return the class that your Attribute Resolver Implements (or an appropriate Factory Bean)","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[102.0]},"content":[{"type":"paragraph","content":[{"text":"doParse","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[72.0]},"content":[{"type":"paragraph","content":[{"text":"Yes","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[786.0]},"content":[{"type":"paragraph","content":[{"text":"To parse your native Schema and populate the Data Connector or its Factory Bean","type":"text"}]},{"type":"paragraph","content":[{"text":"Ensure that this methods starts with a call to ","type":"text"},{"text":"super.doParse()","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":" The above are the methods you have to implement. There are others, consult the Javadoc for the abstract class and its parent classes for more details.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Native Spring Configuration","type":"text"}]},{"type":"paragraph","content":[{"text":"It is possible to configure a data connector in \"native\" Spring and refer to it (as a dependency) in the proprietary syntax attribute-resolver.xml file.","type":"text"}]},{"type":"paragraph"},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"You nearly always a bad idea.","type":"text"},{"type":"hardBreak"},{"type":"hardBreak"},{"text":"There is often a need to do some natic spring programming but the best way is to separate out what you need into a different bean and inject it by name into the custom syntax.","type":"text"}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Native Spring Configuration of the Static Data Connector\"","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Using a Natively define Connector","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"\n \n","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"The native Spring configuration must not go onto the ","type":"text"},{"text":"global.xml","type":"text","marks":[{"type":"code"}]},{"text":" file. It ","type":"text"},{"text":"has","type":"text","marks":[{"type":"strong"}]},{"text":" to be contained in a file which is a peer of the ","type":"text"},{"text":"attribute-resolver.xml","type":"text","marks":[{"type":"code"}]},{"text":" file in the bean defined by ","type":"text"},{"text":"idp.service.attribute.resolver.resources ","type":"text","marks":[{"type":"code"}]},{"text":"(see","type":"text"},{"text":" services.properties","type":"text","marks":[{"type":"code"}]},{"text":").","type":"text"}]},{"type":"paragraph","content":[{"text":"In a standard distribution this bean is defined in","type":"text"},{"text":" services.xml.","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Native Spring Configuration of the Static Data Connector\"","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"\n %{idp.home}/conf/attribute-resolver.xml\n %{idp.home}/conf/your-native-spring-dataconnector.xml\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Dependencies","type":"text"}]},{"type":"paragraph","content":[{"text":"Injecting dependencies into a Attribute Resolver Plugin using native spring is possible, but requires understanding how the Attribute Resolver handles Dependencies.","type":"text"}]},{"type":"paragraph","content":[{"text":"TBD","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}],"version":1}