Anchor | ||||
---|---|---|---|---|
|
Similar to the “SourceInfo”, the framework uses a “PublisherInfo”. This holds information that is used to connect to the a target repository (urlURL, username, password etc.) but and also controls the framework functionality the framework provides. For example, if the framework allows for a transformation , but that a connector may does not require this functionality, so the developer could , you can disable it. . The developer is able to You can extend this, if required, but the .
The framework allows for the following configuration. :
When a connection is required
Pool connections
True/false that connections should be pooled
Use transform
Transform type – none/xml/json + default transform file (to pick out of component)
Supports authentication
http(s)
A set of properties in the
publisher controls the DXF in the common app bundle and the options in the framework.
Use these to control the app bundle loaded (
via the aspire application), and the configuration of the component “publisher info” (for example, to control
whether or not the publisher supports “clear” and “commit” operations
)
Control of the common DXF is by way of a new properties file resources/aspire.properties that is added to the component. This file allows you to add properties.
The developer controls the DXF by setting the properties in resources/aspire.properties like in this example:
Code Block |
---|
component.appbundle.maven.coordinates=app-pap-publisher
#component.<SUBTYPE>.dxf=xxxx
component.default.dxf=dxf/publisher.xml
publisher.framework.isPAP=true
publisher.framework.dxf.merge=true
publisher.framework.dxf.merge.top=true
publisher.framework.dxf.url=true
publisher.framework.dxf.credentials=true
publisher.framework.dxf.startEnd=true
publisher.framework.dxf.transform=true
publisher.framework.dxf.connection=true
publisher.framework.dxf.dumpIndex=false |
Installation settings are collected when the component is installed. The obvious items required are the Required items include location and connection (user/password) details of the target. The desire intent is that only options that the developer has enabled (in the developer settings above Developer Settings) will be presented to the user. The These settings are collected using DXF. A publisher-specific DXF is merged with a common piece to present the entire set.
The framework collects the following parameters:
Target URL
The
URL for the search engine, etc.
Authentication
Yes/
No/
Type
Gather username/password
Clear before full crawls
True/
False. If true, the publisher will
start jobs for full
crawls by calling a clear method
Commit after crawls
True/
False. If true, the publisher will
end jobs for crawls by calling a commit method
Transform data before sending
True/
False
Transform file name
For cases when transformation is required
Control of the DXF etc is via a new properties file added to the component. This file allows the developer to add properties.
Code Block | ||
---|---|---|
| ||
package com.searchtechnologies.aspire.simplefile;
import com.searchtechnologies.aspire.framework.ComponentImpl;
import com.searchtechnologies.aspire.publisher.services.PublisherAccessProvider;
import com.searchtechnologies.aspire.publisher.services.PublisherBatch;
import com.searchtechnologies.aspire.publisher.services.PublisherInfo;
import com.searchtechnologies.aspire.publisher.services.PublisherRepositoryConnection;
import com.searchtechnologies.aspire.publisher.services.queryexpr.DeleteByQuery;
import com.searchtechnologies.aspire.services.AspireException;
import com.searchtechnologies.aspire.services.AspireObject;
import com.searchtechnologies.aspire.services.Job;
import org.w3c.dom.Element;
import java.io.IOException;
import java.io.Writer;
public class SimpleFilePAP extends ComponentImpl implements PublisherAccessProvider {
@Override
public void initialize(Element element) throws AspireException {
}
@Override
public PublisherInfo newPublisherInfo(Element cfg) {
SimpleFilePublisherInfo publisherInfo = new SimpleFilePublisherInfo();
publisherInfo.initialize(cfg);
return publisherInfo;
}
@Override
public void processClear(PublisherRepositoryConnection conn, Job j, PublisherInfo publisherInfo) {
info("Clear job");
}
@Override
public void processCommit(PublisherRepositoryConnection conn, Job j, PublisherInfo publisherInfo) {
info("Commit job");
}
@Override
public void startBatch(PublisherBatch batch, PublisherInfo publisherInfo) {
info("Batch start");
// Add the header
try {
Writer w = (Writer) batch.getBatchConnection().connection();
w.write("<docs>\n");
w.flush();
} catch (IOException e) {
throw new AspireException("SimpleFilePublisher.IOException-writeToStream", e, "IOException writing %s", publisherInfo.getUrl());
}
}
@Override
public void endBatch(PublisherBatch batch, PublisherInfo publisherInfo) {
info("Batch end");
// Add the footer
try {
Writer w = (Writer) batch.getBatchConnection().connection();
w.write("</docs>\n");
w.flush();
} catch (IOException e) {
throw new AspireException("SimpleFilePublisher.IOException-writeToStream", e, "IOException writing %s", publisherInfo.getUrl());
}
}
@Override
public void processAddUpdate(PublisherBatch batch, Job j, PublisherInfo publisherInfo) {
info("Batch process");
Writer w = (Writer) batch.getBatchConnection().connection();
// Write out the document from the job
j.get().toXmlString(AspireObject.PRETTY, w);
}
@Override
public void processDelete(PublisherBatch batch, Job j, PublisherInfo publisherInfo) {
}
@Override
public void processDeleteByQuery(PublisherBatch batch, DeleteByQuery deleteByQuery, Job j, PublisherInfo publisherInfo) {
}
@Override
public void close() {
}
}
|