Skip to content

docs: fix SPI storage plugin example #253

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
anhtnt90dev wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: fix SPI storage plugin example #253

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/design-document/01-spi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ In the future, we might support the implementation to load from the maven reposi

The following is an example of how to use the SPI to declare a plugin.

First, we create an eventmesh-connector-api module, and define the extension interface MeshMQProducer, and we use @EventMeshSPI on the MeshMQProducer,
First, we create an eventmesh-storage-api module, and define the extension interface MeshMQProducer, and we use @EventMeshSPI on the MeshMQProducer,
which indicates the MeshMQProducer is an SPI interface.

```java
Expand All @@ -91,7 +91,7 @@ public interface MeshMQProducer extends Producer {
}
```

Then we create an eventmesh-connector-rocketmq module, which contains the concrete implementation named RocketMQProducerImpl.
Then we create an eventmesh-storage-rocketmq module, which contains the concrete implementation named RocketMQProducerImpl.

```java
public class RocketMQProducerImpl implements MeshMQProducer {
Expand All @@ -100,14 +100,14 @@ public class RocketMQProducerImpl implements MeshMQProducer {
```

At the same time, we need to create a file with the full qualified name of the SPI interface under the resource/META-INF/eventmesh directory
in the eventmesh-connector-rocketmq module.
in the eventmesh-storage-rocketmq module.

org.apache.eventmesh.api.producer.Producer

The content of the file is the extension instance name and the corresponding instance full class name

```properties
rocketmq=org.apache.eventmesh.connector.rocketmq.producer.RocketMQProducerImpl
rocketmq=org.apache.eventmesh.storage.rocketmq.producer.RocketMQProducerImpl
```

At this point, an SPI expansion module is complete. We can use `EventMeshExtensionFactory.getExtension(MeshMQProducer.class, "rocketmq")` to get the `RocketMQProducerImpl` instance.
10 changes: 5 additions & 5 deletions i18n/zh/docusaurus-plugin-content-docs/current/design-document/01-spi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,9 @@ MetaInfExtensionClassLoader 用于从 classPath 直接加载实现类，JarExten

## SPI 使用示例

下面以 eventmesh-connector-plugin 为例，介绍 SPI 具体的使用过程。
下面以 eventmesh-storage-plugin 为例，介绍 SPI 具体的使用过程。

首先定义一个 eventmesh-connector-api 模块，并且定义扩展接口 MeshMQProducer。在 MeshMQProducer 接口上使用@EventMeshSPI 注解进行声明，表明该接口是一个 SPI 扩展接口
首先定义一个 eventmesh-storage-api 模块，并且定义扩展接口 MeshMQProducer。在 MeshMQProducer 接口上使用@EventMeshSPI 注解进行声明，表明该接口是一个 SPI 扩展接口

```java
@EventMeshSPI(isSingleton = false)
Expand All @@ -91,21 +91,21 @@ public interface MeshMQProducer extends Producer {
}
```

eventmesh-connector-rocketmq 模块中包含采用 rocketmq 的具体实现方式 RocketMQProducerImpl。
eventmesh-storage-rocketmq 模块中包含采用 rocketmq 的具体实现方式 RocketMQProducerImpl。

```java
public class RocketMQProducerImpl implements MeshMQProducer {
...
}
```

同时，还需要在 eventmesh-connector-rocketmq 模块中 resource/META-INF/eventmesh 目录下创建文件名为 SPI 接口全限定名的文件
同时，还需要在 eventmesh-storage-rocketmq 模块中 resource/META-INF/eventmesh 目录下创建文件名为 SPI 接口全限定名的文件
org.apache.eventmesh.api.producer.Producer

文件内容为扩展实例名和对应的实例全类名

```properties
rocketmq=org.apache.eventmesh.connector.rocketmq.producer.RocketMQProducerImpl
rocketmq=org.apache.eventmesh.storage.rocketmq.producer.RocketMQProducerImpl
```

至此，一个 SPI 扩展模块就完成了。在使用的时候只需要通过 EventMeshExtensionFactory.getExtension(MeshMQProducer.class, “rocketmq”) 就可以获取 RocketMQProducerImpl 实现类。
10 changes: 5 additions & 5 deletions i18n/zh/docusaurus-plugin-content-docs/version-v1.10.0/design-document/01-spi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,9 @@ MetaInfExtensionClassLoader 用于从 classPath 直接加载实现类，JarExten

## SPI 使用示例

下面以 eventmesh-connector-plugin 为例，介绍 SPI 具体的使用过程。
下面以 eventmesh-storage-plugin 为例，介绍 SPI 具体的使用过程。

首先定义一个 eventmesh-connector-api 模块，并且定义扩展接口 MeshMQProducer。在 MeshMQProducer 接口上使用@EventMeshSPI 注解进行声明，表明该接口是一个 SPI 扩展接口
首先定义一个 eventmesh-storage-api 模块，并且定义扩展接口 MeshMQProducer。在 MeshMQProducer 接口上使用@EventMeshSPI 注解进行声明，表明该接口是一个 SPI 扩展接口

```java
@EventMeshSPI(isSingleton = false)
Expand All @@ -91,21 +91,21 @@ public interface MeshMQProducer extends Producer {
}
```

eventmesh-connector-rocketmq 模块中包含采用 rocketmq 的具体实现方式 RocketMQProducerImpl。
eventmesh-storage-rocketmq 模块中包含采用 rocketmq 的具体实现方式 RocketMQProducerImpl。

```java
public class RocketMQProducerImpl implements MeshMQProducer {
...
}
```

同时，还需要在 eventmesh-connector-rocketmq 模块中 resource/META-INF/eventmesh 目录下创建文件名为 SPI 接口全限定名的文件
同时，还需要在 eventmesh-storage-rocketmq 模块中 resource/META-INF/eventmesh 目录下创建文件名为 SPI 接口全限定名的文件
org.apache.eventmesh.api.producer.Producer

文件内容为扩展实例名和对应的实例全类名

```properties
rocketmq=org.apache.eventmesh.connector.rocketmq.producer.RocketMQProducerImpl
rocketmq=org.apache.eventmesh.storage.rocketmq.producer.RocketMQProducerImpl
```

至此，一个 SPI 扩展模块就完成了。在使用的时候只需要通过 EventMeshExtensionFactory.getExtension(MeshMQProducer.class, “rocketmq”) 就可以获取 RocketMQProducerImpl 实现类。
10 changes: 5 additions & 5 deletions i18n/zh/docusaurus-plugin-content-docs/version-v1.11.0/design-document/01-spi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,9 @@ MetaInfExtensionClassLoader 用于从 classPath 直接加载实现类，JarExten

## SPI 使用示例

下面以 eventmesh-connector-plugin 为例，介绍 SPI 具体的使用过程。
下面以 eventmesh-storage-plugin 为例，介绍 SPI 具体的使用过程。

首先定义一个 eventmesh-connector-api 模块，并且定义扩展接口 MeshMQProducer。在 MeshMQProducer 接口上使用@EventMeshSPI 注解进行声明，表明该接口是一个 SPI 扩展接口
首先定义一个 eventmesh-storage-api 模块，并且定义扩展接口 MeshMQProducer。在 MeshMQProducer 接口上使用@EventMeshSPI 注解进行声明，表明该接口是一个 SPI 扩展接口

```java
@EventMeshSPI(isSingleton = false)
Expand All @@ -91,21 +91,21 @@ public interface MeshMQProducer extends Producer {
}
```

eventmesh-connector-rocketmq 模块中包含采用 rocketmq 的具体实现方式 RocketMQProducerImpl。
eventmesh-storage-rocketmq 模块中包含采用 rocketmq 的具体实现方式 RocketMQProducerImpl。

```java
public class RocketMQProducerImpl implements MeshMQProducer {
...
}
```

同时，还需要在 eventmesh-connector-rocketmq 模块中 resource/META-INF/eventmesh 目录下创建文件名为 SPI 接口全限定名的文件
同时，还需要在 eventmesh-storage-rocketmq 模块中 resource/META-INF/eventmesh 目录下创建文件名为 SPI 接口全限定名的文件
org.apache.eventmesh.api.producer.Producer

文件内容为扩展实例名和对应的实例全类名

```properties
rocketmq=org.apache.eventmesh.connector.rocketmq.producer.RocketMQProducerImpl
rocketmq=org.apache.eventmesh.storage.rocketmq.producer.RocketMQProducerImpl
```

至此，一个 SPI 扩展模块就完成了。在使用的时候只需要通过 EventMeshExtensionFactory.getExtension(MeshMQProducer.class, “rocketmq”) 就可以获取 RocketMQProducerImpl 实现类。
10 changes: 5 additions & 5 deletions i18n/zh/docusaurus-plugin-content-docs/version-v1.12.0/design-document/01-spi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,9 @@ MetaInfExtensionClassLoader 用于从 classPath 直接加载实现类，JarExten

## SPI 使用示例

下面以 eventmesh-connector-plugin 为例，介绍 SPI 具体的使用过程。
下面以 eventmesh-storage-plugin 为例，介绍 SPI 具体的使用过程。

首先定义一个 eventmesh-connector-api 模块，并且定义扩展接口 MeshMQProducer。在 MeshMQProducer 接口上使用@EventMeshSPI 注解进行声明，表明该接口是一个 SPI 扩展接口
首先定义一个 eventmesh-storage-api 模块，并且定义扩展接口 MeshMQProducer。在 MeshMQProducer 接口上使用@EventMeshSPI 注解进行声明，表明该接口是一个 SPI 扩展接口

```java
@EventMeshSPI(isSingleton = false)
Expand All @@ -91,21 +91,21 @@ public interface MeshMQProducer extends Producer {
}
```

eventmesh-connector-rocketmq 模块中包含采用 rocketmq 的具体实现方式 RocketMQProducerImpl。
eventmesh-storage-rocketmq 模块中包含采用 rocketmq 的具体实现方式 RocketMQProducerImpl。

```java
public class RocketMQProducerImpl implements MeshMQProducer {
...
}
```

同时，还需要在 eventmesh-connector-rocketmq 模块中 resource/META-INF/eventmesh 目录下创建文件名为 SPI 接口全限定名的文件
同时，还需要在 eventmesh-storage-rocketmq 模块中 resource/META-INF/eventmesh 目录下创建文件名为 SPI 接口全限定名的文件
org.apache.eventmesh.api.producer.Producer

文件内容为扩展实例名和对应的实例全类名

```properties
rocketmq=org.apache.eventmesh.connector.rocketmq.producer.RocketMQProducerImpl
rocketmq=org.apache.eventmesh.storage.rocketmq.producer.RocketMQProducerImpl
```

至此，一个 SPI 扩展模块就完成了。在使用的时候只需要通过 EventMeshExtensionFactory.getExtension(MeshMQProducer.class, “rocketmq”) 就可以获取 RocketMQProducerImpl 实现类。
8 changes: 4 additions & 4 deletions versioned_docs/version-v1.10.0/design-document/01-spi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ In the future, we might support the implementation to load from the maven reposi

The following is an example of how to use the SPI to declare a plugin.

First, we create an eventmesh-connector-api module, and define the extension interface MeshMQProducer, and we use @EventMeshSPI on the MeshMQProducer,
First, we create an eventmesh-storage-api module, and define the extension interface MeshMQProducer, and we use @EventMeshSPI on the MeshMQProducer,
which indicates the MeshMQProducer is an SPI interface.

```java
Expand All @@ -91,7 +91,7 @@ public interface MeshMQProducer extends Producer {
}
```

Then we create an eventmesh-connector-rocketmq module, which contains the concrete implementation named RocketMQProducerImpl.
Then we create an eventmesh-storage-rocketmq module, which contains the concrete implementation named RocketMQProducerImpl.

```java
public class RocketMQProducerImpl implements MeshMQProducer {
Expand All @@ -100,14 +100,14 @@ public class RocketMQProducerImpl implements MeshMQProducer {
```

At the same time, we need to create a file with the full qualified name of the SPI interface under the resource/META-INF/eventmesh directory
in the eventmesh-connector-rocketmq module.
in the eventmesh-storage-rocketmq module.

org.apache.eventmesh.api.producer.Producer

The content of the file is the extension instance name and the corresponding instance full class name

```properties
rocketmq=org.apache.eventmesh.connector.rocketmq.producer.RocketMQProducerImpl
rocketmq=org.apache.eventmesh.storage.rocketmq.producer.RocketMQProducerImpl
```

At this point, an SPI expansion module is complete. We can use `EventMeshExtensionFactory.getExtension(MeshMQProducer.class, "rocketmq")` to get the `RocketMQProducerImpl` instance.
8 changes: 4 additions & 4 deletions versioned_docs/version-v1.11.0/design-document/01-spi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ In the future, we might support the implementation to load from the maven reposi

The following is an example of how to use the SPI to declare a plugin.

First, we create an eventmesh-connector-api module, and define the extension interface MeshMQProducer, and we use @EventMeshSPI on the MeshMQProducer,
First, we create an eventmesh-storage-api module, and define the extension interface MeshMQProducer, and we use @EventMeshSPI on the MeshMQProducer,
which indicates the MeshMQProducer is an SPI interface.

```java
Expand All @@ -91,7 +91,7 @@ public interface MeshMQProducer extends Producer {
}
```

Then we create an eventmesh-connector-rocketmq module, which contains the concrete implementation named RocketMQProducerImpl.
Then we create an eventmesh-storage-rocketmq module, which contains the concrete implementation named RocketMQProducerImpl.

```java
public class RocketMQProducerImpl implements MeshMQProducer {
Expand All @@ -100,14 +100,14 @@ public class RocketMQProducerImpl implements MeshMQProducer {
```

At the same time, we need to create a file with the full qualified name of the SPI interface under the resource/META-INF/eventmesh directory
in the eventmesh-connector-rocketmq module.
in the eventmesh-storage-rocketmq module.

org.apache.eventmesh.api.producer.Producer

The content of the file is the extension instance name and the corresponding instance full class name

```properties
rocketmq=org.apache.eventmesh.connector.rocketmq.producer.RocketMQProducerImpl
rocketmq=org.apache.eventmesh.storage.rocketmq.producer.RocketMQProducerImpl
```

At this point, an SPI expansion module is complete. We can use `EventMeshExtensionFactory.getExtension(MeshMQProducer.class, "rocketmq")` to get the `RocketMQProducerImpl` instance.
8 changes: 4 additions & 4 deletions versioned_docs/version-v1.12.0/design-document/01-spi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ In the future, we might support the implementation to load from the maven reposi

The following is an example of how to use the SPI to declare a plugin.

First, we create an eventmesh-connector-api module, and define the extension interface MeshMQProducer, and we use @EventMeshSPI on the MeshMQProducer,
First, we create an eventmesh-storage-api module, and define the extension interface MeshMQProducer, and we use @EventMeshSPI on the MeshMQProducer,
which indicates the MeshMQProducer is an SPI interface.

```java
Expand All @@ -91,7 +91,7 @@ public interface MeshMQProducer extends Producer {
}
```

Then we create an eventmesh-connector-rocketmq module, which contains the concrete implementation named RocketMQProducerImpl.
Then we create an eventmesh-storage-rocketmq module, which contains the concrete implementation named RocketMQProducerImpl.

```java
public class RocketMQProducerImpl implements MeshMQProducer {
Expand All @@ -100,14 +100,14 @@ public class RocketMQProducerImpl implements MeshMQProducer {
```

At the same time, we need to create a file with the full qualified name of the SPI interface under the resource/META-INF/eventmesh directory
in the eventmesh-connector-rocketmq module.
in the eventmesh-storage-rocketmq module.

org.apache.eventmesh.api.producer.Producer

The content of the file is the extension instance name and the corresponding instance full class name

```properties
rocketmq=org.apache.eventmesh.connector.rocketmq.producer.RocketMQProducerImpl
rocketmq=org.apache.eventmesh.storage.rocketmq.producer.RocketMQProducerImpl
```

At this point, an SPI expansion module is complete. We can use `EventMeshExtensionFactory.getExtension(MeshMQProducer.class, "rocketmq")` to get the `RocketMQProducerImpl` instance.